Bug 1233 - Improving LibreSOC Documentation Part-2
Summary: Improving LibreSOC Documentation Part-2
Status: CONFIRMED
Alias: None
Product: Libre-SOC's first SoC
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: PC Windows
: --- enhancement
Assignee: Andrey Miroshnikov
URL:
Depends on: 1126
Blocks: 1211
  Show dependency treegraph
 
Reported: 2023-12-05 20:01 GMT by Andrey Miroshnikov
Modified: 2023-12-21 05:09 GMT (History)
4 users (show)

See Also:
NLnet milestone: NLnet.2023-12-059.expansion
total budget (EUR) for completion of task and all subtasks: 0
budget (EUR) for this task, excluding subtasks' budget: 0
parent task for budget allocation:
child tasks for budget allocation:
The table of payments (in EUR) for this task; TOML format:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Andrey Miroshnikov 2023-12-05 20:01:44 GMT
Continuation from https://bugs.libre-soc.org/show_bug.cgi?id=1126
* improve budget-sync
  https://git.libre-soc.org/?p=utils.git;a=summary
* Improve and clarify processes within LibreSOC
  Main pages updated:
  * https://libre-soc.org/HDL_workflow/
  * https://libre-soc.org/HDL_workflow/libresoc_bug_process/
  * https://libre-soc.org/HDL_workflow/rfp_submission_guide/
* Create CI system for bugreport automatic unit testing,
  for NLnet to see results prior to RFP payment approval.

--

Task list:

* TODO Document interdependency when changing SVP64 spec, bug #1126 comment #11
* TODO Link #1164 into HDL Workflow and to main page to help onboarding, bug #1126 comment #14
* TODO Document how to add sub-tasks to task under existing milestone, bug #1126 comment #15
* TODO Planning '3 revisions', bug #1126 comment #22
* TODO TODO list in comment0 of bugs, bug #1126 comment#28
* TODO Include section on CI system, bug #1126 comment #32 bug #1126 comment #33 bug #1126 comment #34
* TODO Meeting minutes procedure and practice, bug #1126 comment #39
* TODO Example of why discussion important bug bug #973 comment #1
* TODO Document RfP submission process, bug #1126 comment #41
* TODO Document procedure to contact NLnet in the event of secret RfP URL leak, bug #1126 comment #45
* TODO https://bugs.libre-soc.org/show_bug.cgi?id=1126#c50
* TODO budget-sync cross-check financial records with NLnet RFP system
Comment 1 Andrey Miroshnikov 2023-12-20 21:43:18 GMT
Luke, spotted two issues with in
https://libre-soc.org/HDL_workflow/rfp_submission_guide/

>second: you click the "submit" button then fill in your
>bank details and name from the dropdown. then you put
>in the amounts, under each milestone.

Instructions for secret RfP system supposed to be
- Click "New Request", then fill in bank info.
- Do not proceed further until step 6.

At step 6, add:
- Return to the RfP system, and press 'Check'. Make sure the selected recipient and entered bank details, the milestones/tasks, sub-totals are correct.


Another issue I've found is a lack of step 8 (you seem to jump from "seventh" to "ninth"). I could decrement the latter step numbers to correct this.
Comment 2 Andrey Miroshnikov 2023-12-20 21:50:51 GMT
(In reply to Andrey Miroshnikov from comment #1)
> Luke, spotted two issues with in
> https://libre-soc.org/HDL_workflow/rfp_submission_guide/
Forgot another one.

Luke, under point 11 you mention:
>there should also neither be
>tasks listed as "paid" that are not listed on the RFP, or
>tasks on the RFP but that are not listed on the payee mdwn file.

The second part of this doesn't sound correct, because the payee may have submitted RfP's previously, thus there would be paid tasks under the personal .mdwn file which are *not* part of the current RfP.
Comment 3 Andrey Miroshnikov 2023-12-20 21:52:26 GMT
(In reply to Andrey Miroshnikov from comment #2)
> The second part of this doesn't sound correct, because the payee may have
> submitted RfP's previously, thus there would be paid tasks under the
> personal .mdwn file which are *not* part of the current RfP.
Must be too late in the day... I meant the first part.
Comment 4 Luke Kenneth Casson Leighton 2023-12-21 04:45:58 GMT
(In reply to Andrey Miroshnikov from comment #1)
> Luke, spotted two issues with in

oh good.

> At step 6, add:
> - Return to the RfP system, and press 'Check'. Make sure the selected
> recipient and entered bank details, the milestones/tasks, sub-totals are
> correct.

(and add, "the data goes through to the MOU Signatory minus the
bank details, for confidentiality")

> 
> Another issue I've found is a lack of step 8 (you seem to jump from
> "seventh" to "ninth"). I could decrement the latter step numbers to correct
> this.

or add the above as step 7

(In reply to Andrey Miroshnikov from comment #2)

> Luke, under point 11 you mention:
> >there should also neither be
> >tasks listed as "paid" that are not listed on the RFP, or
> >tasks on the RFP but that are not listed on the payee mdwn file.
> 
> The (first) part of this doesn't sound correct, because the payee may have
> submitted RfP's previously, thus there would be paid tasks under the
> personal .mdwn file which are *not* part of the current RfP.

nothing to do specifically with the *current* RFP, you are required
to check against *all* RFPs [within that Grant].

yes, really. [yes i do this routinely and regularly].

otherwise you are either:

* claiming money that you should not be claiming has been paid to you
* *missing out* on money that you *should* have claimed.

yes this would be much easier if budget-sync did it automatically.
but that requires a substantal budget on its own, to read the nlnet
RFP system database and to cross-check it. which we should put in
for under bug #1211

oh.

forgot.

section NN. if the RFP is rejected by a review by the MOU Signatory
then you must remove "submitted=xxxx-yy-zz" from the TOML in order
to keep in sync with NLnet's Financial Records.