Page MenuHomeSoftware Heritage
Differential D7445

roadmap 2022 documentation
ClosedPublic
Actions

Authored by bchauvet on Mar 28 2022, 5:21 PM.

Details

Reviewers
None
Group Reviewers
Reviewers
Maniphest Tasks
T4120: Fix documentation dev build (again)
Commits
rDDOCa282312df539: Add roadmap 2022 document
Summary

2022 roadmap document formatted in rst for publication

Diff Detail

Event Timeline

bchauvet created this revision.Mar 28 2022, 5:21 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptMar 28 2022, 5:21 PM
swh-public-ci added a comment.Mar 28 2022, 5:37 PM

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 rst

Link 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

Harbormaster returned this revision to the author for changes because remote builds failed.Mar 28 2022, 5:37 PM
Harbormaster failed remote builds in B27869: Diff 26953!
ardumont mentioned this in D7446: Install app_label on add_forge_now model classes.Mar 29 2022, 9:28 AM
ardumont mentioned this in D7447: docs/index: Name properly index entry.Mar 29 2022, 9:32 AM
ardumont mentioned this in D7448: Reference the new swh.scrubber module.Mar 29 2022, 9:35 AM
ardumont added a subscriber: ardumont.Mar 29 2022, 9:38 AM

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,

ardumont added a comment.Mar 29 2022, 9:56 AM

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.

olasd added a subscriber: olasd.Mar 29 2022, 11:02 AM
In D7445#194256, @ardumont wrote:

Build has FAILED

The first warning/error [a] should be taken care of by D7446.

[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.

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?

bchauvet updated this revision to Diff 26976.Mar 29 2022, 11:53 AM
  • roadmap-2022-doc fix warnings in roadmap-2022.rst
ardumont added a comment.Mar 29 2022, 11:55 AM

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.

swh-public-ci added a comment.Mar 29 2022, 12:08 PM

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 rst

Link 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

Harbormaster returned this revision to the author for changes because remote builds failed.Mar 29 2022, 12:08 PM
Harbormaster failed remote builds in B27892: Diff 26976!
vlorentz added a subscriber: vlorentz.Mar 29 2022, 4:44 PM

LGTM. Some nitpicky proofreading:

docs/roadmap/roadmap-2022.rst
37–38
77–85

not sure how this would be rendered with mismatched indentation

113
129–135
157–162

ditto

186–187

ditto

232
251
321–324
477

Looks like a NBSP? Phab doesn't like it

500–503
650–658

ditto

716–720
744
848
870
bchauvet updated this revision to Diff 27058.Mar 30 2022, 12:34 AM
bchauvet marked 16 inline comments as done.
  • fixed formatting
bchauvet added a comment.Mar 30 2022, 12:34 AM
This comment was removed by bchauvet.
swh-public-ci added a comment.Mar 30 2022, 12:48 AM

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 rst

Link 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

Harbormaster returned this revision to the author for changes because remote builds failed.Mar 30 2022, 12:48 AM
Harbormaster failed remote builds in B27975: Diff 27058!
ardumont mentioned this in D7466: docs/cli: Align cli documentation toc setup.Mar 30 2022, 10:19 AM
ardumont mentioned this in D7467: docs/cli: Align cli documentation toc setup.Mar 30 2022, 11:03 AM
ardumont mentioned this in D7471: add-new-package: Update with necessary documentation instructions.Mar 30 2022, 1:17 PM
ardumont added a task: T4120: Fix documentation dev build (again).Mar 30 2022, 4:59 PM
ardumont added a comment.Mar 30 2022, 6:38 PM

@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,

bchauvet updated this revision to Diff 27127.Mar 31 2022, 9:09 AM
  • modified InvenioRDM KPIs
swh-public-ci added a comment.Mar 31 2022, 9:24 AM

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 rst

Link 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

Harbormaster returned this revision to the author for changes because remote builds failed.Mar 31 2022, 9:24 AM
Harbormaster failed remote builds in B28043: Diff 27127!
ardumont added a comment.Mar 31 2022, 4:35 PM

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

olasd added inline comments.Mar 31 2022, 7:50 PM
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.

ardumont mentioned this in D7481: roadmap-2022-doc publication document formatted in rst.Apr 1 2022, 9:49 AM
bchauvet updated this revision to Diff 27139.Apr 1 2022, 9:59 AM

Add 2022 roadmap document + updated index toc

swh-public-ci added a comment.Apr 1 2022, 10:14 AM

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 document

Link 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

Harbormaster returned this revision to the author for changes because remote builds failed.Apr 1 2022, 10:14 AM
Harbormaster failed remote builds in B28059: Diff 27139!
This revision was not accepted when it landed; it landed in state Changes Planned.Apr 1 2022, 10:23 AM
This revision was landed with ongoing or failed builds.
Closed by commit rDDOCa282312df539: Add roadmap 2022 document (authored by bchauvet). · Explain Why
This revision was automatically updated to reflect the committed changes.
bchauvet added a commit: rDDOCa282312df539: Add roadmap 2022 document.

Revision Contents
Changeset List

PathSize
docs/
roadmap/
834 lines

Diff 27127

View Options

docs/roadmap/roadmap-2022.rst

Loading...
About · Developer information · Legal