Page MenuHomeSoftware Heritage

mirror-operations: Convert markup to restructuredtext
ClosedPublic

Authored by ardumont on Jan 18 2022, 3:49 PM.

Details

Summary
  • Fix warnings
  • Fix markdown link
  • Add intended audience

Related to T3829

Test Plan

make -C sysadm html happy and beautiful ;)

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

Build has FAILED

Patch application report for D6965 (id=25262)

Rebasing onto 6cacfbdd32...

Current branch diff-target is up to date.
Changes applied before test
commit d0e42db1d3b06f39bf1eaae25fe012c483a7ec63
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Tue Jan 18 15:47:34 2022 +0100

    mirror-operations: Convert markup to restructuredtext

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

Harbormaster returned this revision to the author for changes because remote builds failed.Jan 18 2022, 3:54 PM
Harbormaster failed remote builds in B26124: Diff 25262!

Build has FAILED

Patch application report for D6965 (id=25262)

Rebasing onto 578f414aca...

First, rewinding head to replay your work on top of it...
Applying: mirror-operations: Convert markup to restructuredtext
Changes applied before test
commit a660c6d8af6637a0e0280df1e31ef2b0b722e3fe
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Tue Jan 18 15:47:34 2022 +0100

    mirror-operations: Convert markup to restructuredtext

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

Fix build (unrelated change inside)

Build has FAILED

Patch application report for D6965 (id=25267)

Rebasing onto 578f414aca...

Current branch diff-target is up to date.
Changes applied before test
commit 7e2eeec1f7aff7d98c50d670c64efb022207bfbc
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Tue Jan 18 17:01:28 2022 +0100

    user/faq: Fix save code now link warning
    
    This fixes build [1]
16:47:16  /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/user/faq/index.rst:41: WARNING: hardcoded link 'https://archive.softwareheritage.org/save/' could be replaced by an extlink (try using ':swh_web:`save/`' instead)
```

[1] https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/59/console

commit bfba4e7211918c72a49122550efcc70b8245a2d5
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date: Tue Jan 18 15:47:34 2022 +0100

mirror-operations: Convert markup to restructuredtext
Link to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/61/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/61/console
Harbormaster returned this revision to the author for changes because remote builds failed.Jan 18 2022, 5:09 PM
Harbormaster failed remote builds in B26128: Diff 25267!

Build has FAILED

Patch application report for D6965 (id=25270)

Could not rebase; Attempt merge onto 578f414aca...

Updating 578f414..cdddf07
Fast-forward
 sysadm/mirror-operations/docker.rst | 51 +++++++++++++++++++++----------------
 user/faq/index.rst                  |  2 +-
 2 files changed, 30 insertions(+), 23 deletions(-)
Changes applied before test
commit cdddf07fe521a29cd1aa93d9568efe1ed4029ffc
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Tue Jan 18 15:47:34 2022 +0100

    mirror-operations: Convert markup to restructuredtext

commit 0df63d1ae7fa0f34fe594b71f35a23ea48927031
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Tue Jan 18 17:01:28 2022 +0100

    user/faq: Fix save code now link warning
    
    This fixes build [1]
16:47:16  /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/user/faq/index.rst:41: WARNING: hardcoded link 'https://archive.softwareheritage.org/save/' could be replaced by an extlink (try using ':swh_web:`save/`' instead)
```

[1] https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/59/console
Link to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/63/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/63/console
Harbormaster returned this revision to the author for changes because remote builds failed.Jan 18 2022, 5:21 PM
Harbormaster failed remote builds in B26130: Diff 25270!

Build is green

Patch application report for D6965 (id=25293)

Could not rebase; Attempt merge onto 3a3fff1438...

Updating 3a3fff1..f75b1db
Fast-forward
 docs/architecture/overview.rst      |  23 +++---
 docs/faq/index.rst                  |   6 +-
 docs/getting-started/api.rst        | 139 ++++++++++++++++--------------------
 sysadm/mirror-operations/docker.rst |  51 +++++++------
 4 files changed, 102 insertions(+), 117 deletions(-)
Changes applied before test
commit f75b1db1d633b6418ea7a725e8cfa4c44dee160a
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Tue Jan 18 15:47:34 2022 +0100

    mirror-operations: Convert markup to restructuredtext

commit c2a33de47e67e73cbf8a01d238e3036868827763
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Tue Jan 18 17:01:28 2022 +0100

    docs: Fix redondant extlink link warnings on archive.s.o
    
    This fixes warning like [1] and attempt to fix the build [2]
    
    [1]
16:47:16  /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/user/faq/index.rst:41: WARNING: hardcoded link 'https://archive.softwareheritage.org/save/' could be replaced by an extlink (try using ':swh_web:`save/`' instead)
```

[2] https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/59/console
See https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/76/ for more details.
This revision was not accepted when it landed; it landed in state Needs Review.Jan 19 2022, 12:11 PM
ardumont requested review of this revision.
This revision was automatically updated to reflect the committed changes.