Page MenuHomeSoftware Heritage

add a documentation landing page
AcceptedPublic

Authored by bchauvet on Aug 25 2022, 2:09 PM.

Diff Detail

Event Timeline

Build has FAILED

Patch application report for D8314 (id=30027)

Rebasing onto 79efac6b30...

Current branch diff-target is up to date.
Changes applied before test
commit 4ace373d5d174d949120809f2e5157746a2ee105
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date:   Thu Aug 25 14:07:51 2022 +0200

    add a documentation landing page

Link to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/218/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/218/console

Harbormaster returned this revision to the author for changes because remote builds failed.Aug 25 2022, 2:12 PM
Harbormaster failed remote builds in B31077: Diff 30027!

removed "general" declaration from intersphinx config

Build has FAILED

Patch application report for D8314 (id=30029)

Could not rebase; Attempt merge onto 9587786b4e...

Merge made by the 'recursive' strategy.
 docs/_templates/layout.html            |  38 ++++++++++++++++++++-
 docs/contributing/index.rst            |   2 ++
 docs/getting-started/index.rst         |   2 ++
 docs/tutorials/index.rst               |   2 ++
 general/.gitignore                     |   4 +++
 general/Makefile                       |  20 +++++++++++
 general/_static                        |   1 +
 general/_templates/.placeholder        |   0
 general/_templates/breadcrumbs.html    |  15 +++++++++
 general/_templates/layout.html         |  53 +++++++++++++++++++++++++++++
 general/conf.py                        |   3 ++
 general/index.rst                      |  45 +++++++++++++++++++++++++
 general/logos/archive.png              | Bin 0 -> 4056 bytes
 general/logos/bazaar.png               | Bin 0 -> 13321 bytes
 general/logos/bitbucket.png            | Bin 0 -> 3133 bytes
 general/logos/cgit.png                 | Bin 0 -> 1950 bytes
 general/logos/cran.png                 | Bin 0 -> 8703 bytes
 general/logos/crates.png               | Bin 0 -> 14681 bytes
 general/logos/cvs.png                  | Bin 0 -> 2758 bytes
 general/logos/debian.png               | Bin 0 -> 4949 bytes
 general/logos/deposit.png              | Bin 0 -> 13316 bytes
 general/logos/git.png                  | Bin 0 -> 3692 bytes
 general/logos/gitea.png                | Bin 0 -> 4543 bytes
 general/logos/github.png               | Bin 0 -> 2242 bytes
 general/logos/gitlab.png               | Bin 0 -> 4503 bytes
 general/logos/gnu.png                  | Bin 0 -> 10864 bytes
 general/logos/launchpad.png            | Bin 0 -> 5801 bytes
 general/logos/maven.png                | Bin 0 -> 4565 bytes
 general/logos/mercurial.png            | Bin 0 -> 13208 bytes
 general/logos/nixguix.png              | Bin 0 -> 9874 bytes
 general/logos/npm.png                  | Bin 0 -> 2385 bytes
 general/logos/opam.png                 | Bin 0 -> 16402 bytes
 general/logos/packagist.png            | Bin 0 -> 11695 bytes
 general/logos/phabricator.png          | Bin 0 -> 3115 bytes
 general/logos/pypi.png                 | Bin 0 -> 10482 bytes
 general/logos/sourceforge.png          | Bin 0 -> 3553 bytes
 general/logos/subversion.png           | Bin 0 -> 7792 bytes
 general/logos/tuleap.png               | Bin 0 -> 5902 bytes
 general/make.bat                       |  35 +++++++++++++++++++
 swh/docs/sphinx/conf.py                |   2 ++
 sysadm/_templates/layout.html          |  41 ++++++++++++++++++++++-
 sysadm/data-silos/index.rst            |   2 ++
 sysadm/deployment/index.rst            |   2 ++
 sysadm/index.rst                       |   2 ++
 sysadm/life-cycle-management/index.rst |   2 ++
 sysadm/puppet/index.rst                |   2 ++
 sysadm/server-architecture/index.rst   |   2 ++
 sysadm/support-services/index.rst      |   2 ++
 sysadm/user-management/index.rst       |   2 ++
 user/_templates/layout.html            |  59 +++++++++++++++++++++++++++++++++
 50 files changed, 336 insertions(+), 2 deletions(-)
 create mode 100644 general/.gitignore
 create mode 100644 general/Makefile
 create mode 120000 general/_static
 create mode 100644 general/_templates/.placeholder
 create mode 100644 general/_templates/breadcrumbs.html
 create mode 100644 general/_templates/layout.html
 create mode 100644 general/conf.py
 create mode 100644 general/index.rst
 create mode 100644 general/logos/archive.png
 create mode 100644 general/logos/bazaar.png
 create mode 100644 general/logos/bitbucket.png
 create mode 100644 general/logos/cgit.png
 create mode 100644 general/logos/cran.png
 create mode 100644 general/logos/crates.png
 create mode 100644 general/logos/cvs.png
 create mode 100644 general/logos/debian.png
 create mode 100644 general/logos/deposit.png
 create mode 100644 general/logos/git.png
 create mode 100644 general/logos/gitea.png
 create mode 100644 general/logos/github.png
 create mode 100644 general/logos/gitlab.png
 create mode 100644 general/logos/gnu.png
 create mode 100644 general/logos/launchpad.png
 create mode 100644 general/logos/maven.png
 create mode 100644 general/logos/mercurial.png
 create mode 100644 general/logos/nixguix.png
 create mode 100644 general/logos/npm.png
 create mode 100644 general/logos/opam.png
 create mode 100644 general/logos/packagist.png
 create mode 100644 general/logos/phabricator.png
 create mode 100644 general/logos/pypi.png
 create mode 100644 general/logos/sourceforge.png
 create mode 100644 general/logos/subversion.png
 create mode 100644 general/logos/tuleap.png
 create mode 100644 general/make.bat
 create mode 100644 user/_templates/layout.html
Changes applied before test
commit fb6df96348f8ef187e4ef7cdf1e08ebce7138acc
Merge: 9587786 ba7dbeb
Author: Jenkins user <jenkins@localhost>
Date:   Thu Aug 25 12:52:59 2022 +0000

    Merge branch 'diff-target'

commit ba7dbeb007de81066c0c30de9716b0c7cddb5041
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date:   Thu Aug 25 14:51:18 2022 +0200

    add a documentation landing page

commit 4ace373d5d174d949120809f2e5157746a2ee105
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date:   Thu Aug 25 14:07:51 2022 +0200

    add a documentation landing page

Link to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/219/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/219/console

Harbormaster returned this revision to the author for changes because remote builds failed.Aug 25 2022, 3:04 PM
Harbormaster failed remote builds in B31079: Diff 30029!

fixed duplicate anchor label

Build is green

Patch application report for D8314 (id=30031)

Rebasing onto 9587786b4e...

First, rewinding head to replay your work on top of it...
Applying: add a documentation landing page
Changes applied before test
commit 67ca059be773150e3d03fdd4b9e8bab2903da146
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date:   Thu Aug 25 14:07:51 2022 +0200

    add a documentation landing page

See https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/220/ for more details.

Can you please add a screenshot of the rendering in the diff description (drag'n drop in the textbox just works ;)?
TIA

Why duplicating loader/lister logos ? I do not get its purpose.

For the record, that new doc is not build by our CI, apply this patch to do it.

diff --git a/tox.ini b/tox.ini
index 3e768bf..52f8678 100644
--- a/tox.ini
+++ b/tox.ini
@@ -16,6 +16,7 @@ setenv =
 commands =
   {envpython} -m pifpaf run postgresql -- make -C sysadm {posargs:html}
   {envpython} -m pifpaf run postgresql -- make -C user {posargs:html}
+  {envpython} -m pifpaf run postgresql -- make -C general {posargs:html}
   {envpython} -m pifpaf run postgresql -- make -C docs {posargs:html}
 
 [testenv:sphinx-dev]
@@ -28,6 +29,7 @@ setenv =
 commands =
   {envpython} -m pifpaf run postgresql -- make -C sysadm {posargs:html}
   {envpython} -m pifpaf run postgresql -- make -C user {posargs:html}
+  {envpython} -m pifpaf run postgresql -- make -C general {posargs:html}
   {envpython} -m pifpaf run postgresql -- make -C docs {posargs:html}

I am also wondering if we really need a new sphinx doc folder. I think adding a landing page in the swh-docs/docs folder
would be more adequate and it should simplify referencing user, sysadmin and development doc.
I will take a lookt at it tomorrow.

vlorentz added inline comments.
docs/getting-started/index.rst
1

Why duplicating loader/lister logos ? I do not get its purpose.

I forgot to remove the folder when duplicated the user folder. Before pushing it, I wait for the decision to simply add a landing page in the docs folder

docs/getting-started/index.rst
1

the "_getting-started" tag already exists in docs/getting-started.rst

docs/getting-started/index.rst
1

ugh, right. It's a bad style to have two conflicting names like this. Could you merge docs/getting-started.rst into this file, instead?

docs/getting-started/index.rst
1

maybe this can be iterated over once this lands?

This seems like a right push in the right direction to have this landing page but blocked by "tiny" implementation details so far.

This revision is now accepted and ready to land.Oct 3 2022, 2:10 PM

See D8894 for an alternative implementation.