Reorganize deposit documentation in three sections: API, internals, and specifications.
ClosedPublic
Actions

Authored by vlorentz on Apr 8 2021, 11:47 AM.

Details

Reviewers

moranegg
ardumont

Group Reviewers

Reviewers

Commits

rDDEP0398bcb811a3: Reorganize deposit documentation in three sections: API, internals, and…

Summary

This moves files around, so it will cause stale or broken links.
A future commit in swh-docs will set up redirects so the old URLs
still point to up-to-date documents.

Diff Detail

Repository

rDDEP Push deposit

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

vlorentz created this revision.Apr 8 2021, 11:47 AM

Herald added a reviewer: Reviewers. · View Herald TranscriptApr 8 2021, 11:47 AM

vlorentz added reviewers: moranegg, ardumont.Apr 8 2021, 11:47 AM

Build is green

Patch application report for D5450 (id=19480)

Could not rebase; Attempt merge onto 288bb48c35...

Updating 288bb48c..0398bcb8
Fast-forward
 docs/README.rst                                    |  4 +-
 docs/{spec-api.rst => api/api-documentation.rst}   |  0
 docs/api/index.rst                                 | 13 +++++
 docs/{ => api}/metadata.rst                        |  0
 docs/{specs/blueprint.rst => api/use-cases.rst}    |  0
 docs/{ => api}/user-manual.rst                     |  0
 docs/cli.rst                                       |  2 +
 docs/index.rst                                     |  9 +--
 docs/{ => internals}/authentication.rst            |  0
 .../dev-environment.rst}                           |  6 +-
 docs/internals/index.rst                           | 14 +++++
 .../prod-environment.rst}                          |  8 +--
 docs/specs/index.rst                               |  5 +-
 docs/specs/spec-loading.rst                        |  2 +-
 docs/tests/tests_HAL.rst                           | 67 ----------------------
 15 files changed, 43 insertions(+), 87 deletions(-)
 rename docs/{spec-api.rst => api/api-documentation.rst} (100%)
 create mode 100644 docs/api/index.rst
 rename docs/{ => api}/metadata.rst (100%)
 rename docs/{specs/blueprint.rst => api/use-cases.rst} (100%)
 rename docs/{ => api}/user-manual.rst (100%)
 rename docs/{ => internals}/authentication.rst (100%)
 rename docs/{dev-info.rst => internals/dev-environment.rst} (97%)
 create mode 100644 docs/internals/index.rst
 rename docs/{sys-info.rst => internals/prod-environment.rst} (96%)
 delete mode 100644 docs/tests/tests_HAL.rst

Changes applied before test

commit 0398bcb811a3592702a99d7fcb4b974938bbbd83
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 11:47:18 2021 +0200

    Reorganize deposit documentation in three sections: API, internals, and specifications.
    
    This moves files around, so it will cause stale or broken links.
    A future commit in swh-docs will set up redirects so the old URLs
    still point to up-to-date documents.

commit 06792826367e10cf004b0197e74995eb71febc2e
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 11:00:22 2021 +0200

    docs: Fix typo (release -> revision)

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/615/ for more details.

Harbormaster completed remote builds in B20523: Diff 19480.Apr 8 2021, 11:50 AM

vlorentz requested review of this revision.Apr 8 2021, 11:50 AM

lgtm

docs/internals/dev-environment.rst
12	That one i think should be reworked to make our docker dev stack appear... (not for this diff just to share my view on the subject) That's how i started doing dev on it at first, now i'm relying a lot on tests for hacking. Then running the deposit with docker to confirm everything is indeed fine...