2022 roadmap document formatted in rst for publication
Details
Details
- Reviewers
- None
- Group Reviewers
Reviewers - Maniphest Tasks
- T4120: Fix documentation dev build (again)
- Commits
- rDDOCa282312df539: Add roadmap 2022 document
Diff Detail
Diff Detail
- Repository
- rDDOC Development documentation
- Lint
Automatic diff as part of commit; lint not applicable. - Unit
Automatic diff as part of commit; unit tests not applicable.
Event Timeline
Comment Actions
Build has FAILED
Patch application report for D7445 (id=26953)
Rebasing onto f6e7503224...
Current branch diff-target is up to date.
Changes applied before test
commit d59d3d6243d6192cfd9f5978c7e1a5f085c788e7
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Mon Mar 28 17:15:41 2022 +0200
roadmap-2022-doc publication document formatted in rstLink to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/126/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/126/console
Comment Actions
Build has FAILED
@bchauvet The gist of the build failure [1] is that we treat warnings as errors. That
consequently make your diff build fail.
While there are some issues unrelated to your changes (I've proposed diffs below to fix
those "upstream"), the ones in the middle (between the inserted blanks), you should be
able to fix yourself.
The first warning/error [a] should be taken care of by D7446.
The second point [b] should be taken care of by the composite diffs D7447 and D7448.
[1]
[a] 17:35:41 RuntimeError: Model class swh.web.add_forge_now.models.RequestHistory doesn't declare an explicit app_label and isn't in an application in INSTALLED_APPS. 17:35:41 /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/docs/roadmap/roadmap-2022.rst:560: WARNING: Bullet list ends without a blank line; unexpected unindent. 17:35:41 /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/docs/roadmap/roadmap-2022.rst:866: WARNING: Unexpected indentation. 17:35:41 /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/docs/apidoc/swh.web.inbound_email.management.rst: WARNING: document isn't included in any toctree 17:35:41 /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/docs/roadmap/roadmap-2022.rst: WARNING: document isn't included in any toctree [b] 17:35:41 /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/docs/swh-scrubber/index.rst: WARNING: document isn't included in any toctree
Cheers,
Comment Actions
17:35:41 /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/docs/apidoc/swh.web.inbound_email.management.rst: WARNING: document isn't included in any toctree
This needs a change upstream as well.
I've tentatively opened D7449 for this one.
Comment Actions
That's a bit dubious. What's the django settings module used for the docs build and what are the INSTALLED_APPS there? Do we set app_labels for other django models?
Comment Actions
That's a bit dubious.
yes, i was dubious as well when i said as much. Well, sphinx and django are not a happy
couple.
What's the django settings module used for the docs build and what are the INSTALLED_APPS there?
iirc, because otherwise sphinx (due to autodoc and the auto import stuff i think?)
refuses to build anything at all.
Do we set app_labels for other django models?
Yes, we do set the app_labels in other models.
Comment Actions
Build has FAILED
Patch application report for D7445 (id=26976)
Rebasing onto f6e7503224...
Current branch diff-target is up to date.
Changes applied before test
commit ed76604739c35296e7f1ea3efe728f1b238beedf
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Tue Mar 29 09:51:31 2022 +0200
roadmap-2022-doc remove warnings
commit d59d3d6243d6192cfd9f5978c7e1a5f085c788e7
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Mon Mar 28 17:15:41 2022 +0200
roadmap-2022-doc publication document formatted in rstLink to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/128/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/128/console
This comment was removed by bchauvet.
Comment Actions
Build has FAILED
Patch application report for D7445 (id=27058)
Rebasing onto f6e7503224...
Current branch diff-target is up to date.
Changes applied before test
commit 69f3fae627327e44bd33b3d1b4713bfadd4008ec
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Wed Mar 30 00:22:25 2022 +0200
fixed formatting
commit ed76604739c35296e7f1ea3efe728f1b238beedf
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Tue Mar 29 09:51:31 2022 +0200
roadmap-2022-doc remove warnings
commit d59d3d6243d6192cfd9f5978c7e1a5f085c788e7
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Mon Mar 28 17:15:41 2022 +0200
roadmap-2022-doc publication document formatted in rstLink to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/130/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/130/console
Comment Actions
@bchauvet Heads up, i've failed to unstuck the last warning (see [1]).
Still, I've pushed nonetheless.
fwiw, i've spent too much time on it for now.
So please, just rebase your code, update the diff and then push (I trust in val's judgement for sphinx stuff ;)
I'll have another stab at this [1] later when i've got some more energy (hopefully someone might have a
stab at this and find the issue).
[1] T4120#82291
Cheers,
Comment Actions
Build has FAILED
Patch application report for D7445 (id=27127)
Rebasing onto 39d9a83813...
First, rewinding head to replay your work on top of it... Applying: roadmap-2022-doc publication document formatted in rst Applying: roadmap-2022-doc remove warnings Applying: fixed formatting Applying: modified InvenioRDM KPIs
Changes applied before test
commit 00157960aac58c90f3076cbefc1a167baf62c35b
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Thu Mar 31 09:08:16 2022 +0200
modified InvenioRDM KPIs
commit d840ee311d570e778a70230c4dc2845dad69ecc4
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Wed Mar 30 00:22:25 2022 +0200
fixed formatting
commit 879127f7b2d7a7bba19f440fccc9da8e37403c7b
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Tue Mar 29 09:51:31 2022 +0200
roadmap-2022-doc remove warnings
commit bea0af7b39cd205693411fdba1ae3499e8d486f4
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Mon Mar 28 17:15:41 2022 +0200
roadmap-2022-doc publication document formatted in rstLink to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/142/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/142/console
Comment Actions
I had forgotten to mention that you'll need to reference that new roadmap in docs/index.rst [1].
Most likely, you'll want to put it in front of the 2021.
That will take care of that new warning in your build:
09:23:13 /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/docs/roadmap/roadmap-2022.rst: WARNING: document isn't included in any toctree
[1] https://forge.softwareheritage.org/source/swh-docs/browse/master/docs/index.rst$52
| docs/roadmap/roadmap-2022.rst | ||
|---|---|---|
| 477 | FWIW, Phab doesn't really "not like it", it just highlights "weird whitespace" so it doesn't get missed during review. | |
Comment Actions
Build has FAILED
Patch application report for D7445 (id=27139)
Rebasing onto 0d1e871c66...
Current branch diff-target is up to date.
Changes applied before test
commit a282312df5392f02a4d69c49e7c9f7ad5efc2cbc
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Mon Mar 28 17:15:41 2022 +0200
Add roadmap 2022 documentLink to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/145/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/145/console