Page MenuHomeSoftware Heritage

Create stub files to redirect
ClosedPublic

Authored by vlorentz on Thu, Apr 8, 1:43 PM.

Details

Summary

This only includes redirects for user documentation;
external links to the developer documentation would be broken,
but I don't think there are any such link and I don't want to
clutter the file tree unnecessarily.

Depends on D5450

Diff Detail

Repository
rDDEP Push deposit
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 20532
Build 31870: Phabricator diff pipeline on jenkinsJenkins console · Jenkins
Build 31869: arc lint + arc unit

Event Timeline

Build is green

Patch application report for D5452 (id=19484)

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

Updating 288bb48c..951c2cc8
Fast-forward
 docs/README.rst                                    |   8 +-
 docs/api/api-documentation.rst                     | 115 +++++
 docs/api/index.rst                                 |  13 +
 docs/api/metadata.rst                              | 200 +++++++++
 docs/api/use-cases.rst                             | 196 +++++++++
 docs/api/user-manual.rst                           | 486 +++++++++++++++++++++
 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/metadata.rst                                  | 200 +--------
 docs/spec-api.rst                                  | 116 +----
 docs/specs/blueprint.rst                           | 195 +--------
 docs/specs/index.rst                               |   5 +-
 docs/specs/spec-loading.rst                        |   2 +-
 docs/tests/tests_HAL.rst                           |  67 ---
 docs/user-manual.rst                               | 486 +--------------------
 19 files changed, 1050 insertions(+), 1078 deletions(-)
 create mode 100644 docs/api/api-documentation.rst
 create mode 100644 docs/api/index.rst
 create mode 100644 docs/api/metadata.rst
 create mode 100644 docs/api/use-cases.rst
 create mode 100644 docs/api/user-manual.rst
 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 951c2cc88217aff59a829115df69434010bf0620
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 13:42:43 2021 +0200

    Create stub files to redirect

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/616/ for more details.

Build is green

Patch application report for D5452 (id=19485)

Rebasing onto 288bb48c35...

Current branch diff-target is up to date.
Changes applied before test
commit 69246fac1b1d0a8c730b7e26ddff6c5c9958da13
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 13:42:43 2021 +0200

    docs: Create stub files to redirect moved pages
    
    This only includes redirects for user documentation;
    external links to the developer documentation would be broken,
    but I don't think there are any such link and I don't want to
    clutter the file tree unnecessarily.

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/617/ for more details.

Build is green

Patch application report for D5452 (id=19486)

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

Updating 288bb48c..69246fac
Fast-forward
 docs/README.rst                                    |   8 +-
 docs/api/api-documentation.rst                     | 115 +++++
 docs/api/index.rst                                 |  13 +
 docs/api/metadata.rst                              | 200 +++++++++
 docs/api/use-cases.rst                             | 196 +++++++++
 docs/api/user-manual.rst                           | 486 +++++++++++++++++++++
 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/metadata.rst                                  | 200 +--------
 docs/spec-api.rst                                  | 116 +----
 docs/specs/blueprint.rst                           | 195 +--------
 docs/specs/index.rst                               |   5 +-
 docs/specs/spec-loading.rst                        |   2 +-
 docs/tests/tests_HAL.rst                           |  67 ---
 docs/user-manual.rst                               | 486 +--------------------
 19 files changed, 1050 insertions(+), 1078 deletions(-)
 create mode 100644 docs/api/api-documentation.rst
 create mode 100644 docs/api/index.rst
 create mode 100644 docs/api/metadata.rst
 create mode 100644 docs/api/use-cases.rst
 create mode 100644 docs/api/user-manual.rst
 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 69246fac1b1d0a8c730b7e26ddff6c5c9958da13
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 13:42:43 2021 +0200

    docs: Create stub files to redirect moved pages
    
    This only includes redirects for user documentation;
    external links to the developer documentation would be broken,
    but I don't think there are any such link and I don't want to
    clutter the file tree unnecessarily.

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/618/ for more details.

Build is green

Patch application report for D5452 (id=19488)

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

Updating 288bb48c..1fa7a648
Fast-forward
 docs/README.rst                                    |   8 +-
 docs/api/api-documentation.rst                     | 115 +++++
 docs/api/index.rst                                 |  13 +
 docs/api/metadata.rst                              | 200 +++++++++
 docs/api/use-cases.rst                             | 196 +++++++++
 docs/api/user-manual.rst                           | 486 +++++++++++++++++++++
 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/metadata.rst                                  | 200 +--------
 docs/spec-api.rst                                  | 116 +----
 docs/specs/blueprint.rst                           | 195 +--------
 docs/specs/index.rst                               |   5 +-
 docs/specs/spec-loading.rst                        |   2 +-
 docs/tests/tests_HAL.rst                           |  67 ---
 docs/user-manual.rst                               | 486 +--------------------
 19 files changed, 1050 insertions(+), 1078 deletions(-)
 create mode 100644 docs/api/api-documentation.rst
 create mode 100644 docs/api/index.rst
 create mode 100644 docs/api/metadata.rst
 create mode 100644 docs/api/use-cases.rst
 create mode 100644 docs/api/user-manual.rst
 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 1fa7a64815bb48497127041add1a851820d44824
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 13:42:43 2021 +0200

    docs: Create stub files to redirect moved pages
    
    This only includes redirects for user documentation;
    external links to the developer documentation would be broken,
    but I don't think there are any such link and I don't want to
    clutter the file tree unnecessarily.

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/619/ for more details.

anlambert added a subscriber: anlambert.
anlambert added inline comments.
docs/metadata.rst
3

missing dot at end of sentence

docs/spec-api.rst
3

typo in the label

This revision now requires changes to proceed.Thu, Apr 8, 2:17 PM

Build is green

Patch application report for D5452 (id=19490)

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

Updating 288bb48c..ab85694f
Fast-forward
 docs/README.rst                                    |   8 +-
 docs/api/api-documentation.rst                     | 115 +++++
 docs/api/index.rst                                 |  13 +
 docs/api/metadata.rst                              | 200 +++++++++
 docs/api/use-cases.rst                             | 196 +++++++++
 docs/api/user-manual.rst                           | 486 +++++++++++++++++++++
 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/metadata.rst                                  | 200 +--------
 docs/spec-api.rst                                  | 116 +----
 docs/specs/blueprint.rst                           | 195 +--------
 docs/specs/index.rst                               |   5 +-
 docs/specs/spec-loading.rst                        |   2 +-
 docs/tests/tests_HAL.rst                           |  67 ---
 docs/user-manual.rst                               | 486 +--------------------
 19 files changed, 1050 insertions(+), 1078 deletions(-)
 create mode 100644 docs/api/api-documentation.rst
 create mode 100644 docs/api/index.rst
 create mode 100644 docs/api/metadata.rst
 create mode 100644 docs/api/use-cases.rst
 create mode 100644 docs/api/user-manual.rst
 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 ab85694f2f8b70039535609369f8558498554939
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 13:42:43 2021 +0200

    docs: Create stub files to redirect moved pages
    
    This only includes redirects for user documentation;
    external links to the developer documentation would be broken,
    but I don't think there are any such link and I don't want to
    clutter the file tree unnecessarily.

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/620/ for more details.

This revision is now accepted and ready to land.Thu, Apr 8, 2:54 PM