Page MenuHomeSoftware Heritage

Add roadmap 2021 to the docs site
AbandonedPublic

Authored by ardumont on Tue, Apr 6, 12:53 PM.

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Maniphest Tasks
T3208: Add roadmap to docs.s.o
Summary

This adds the roadmap entry in the site in the [1]:

  • index menu on the left (prior to the components listing)
  • main page under a Roadmap section just before the components section

Related to T3208

[1]

Test Plan

make -C docs happy.

Diff Detail

Repository
rDDOC Development documentation
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 20440
Build 31724: arc lint + arc unit

Event Timeline

ardumont created this revision.

LGTM.

Why double underscores on all refs?

docs/index.rst
188

(it's redundant)

LGTM.

Why double underscores on all refs?

No idea, pandoc did that.
I rewrote most of what it did regarding headers and all but not the links.
I'll fix it then.

Thanks for the heads up.

Adapt according to review:

  • drop redundant title
  • drop spurious trailing _
  • reword some sentences
  • Fix missed empty line between title and list items

Add roadmap to the main paged

Rework commit and diff description

I'm good with this location.
Just a question about the url, would that be:
docs.softwareheritage.org/roadmap/roadmap-2021
or
docs.softwareheritage.org/devel/roadmap/roadmap-2021?
or both?

I'm good with this location.

great.

Just a question about the url, would that be:
docs.softwareheritage.org/roadmap/roadmap-2021
or
docs.softwareheritage.org/devel/roadmap/roadmap-2021?
or both?

good question, i had to think it over ;)
In the current state of the diff, the second url.

Clearly in devel/, because it's the roadmap for the devel team

Well, there is no harm in landing this as is. And publish.

That will be simpler for people to see and require (or even propose [1]) changes
if they think of something better.

[1] The heavy lifting has been done here, we can always move around the data later.

Landed through e1aed3b1db8924d42ec3a5530bc1356080bc4cf2 (forgot to update the diff after rebase)