Page MenuHomeSoftware Heritage
Differential D4450

Add an annotated table of content at the end of the introduction
ClosedPublic
Actions

Authored by douardda on Nov 9 2020, 4:08 PM.

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Maniphest Tasks
T2751: Clarify in documentation the specs status
Commits
rDDEPc815bbf19a61: Add an annotated table of content at the end of the introduction
Summary

Depends on D4430
Related to T2751.

Diff Detail

Event Timeline

douardda created this revision.Nov 9 2020, 4:08 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptNov 9 2020, 4:08 PM
douardda edited the summary of this revision. (Show Details)Nov 9 2020, 4:10 PM
douardda added a task: T2751: Clarify in documentation the specs status.
swh-public-ci added a comment.Nov 9 2020, 4:13 PM

Build is green

Patch application report for D4450 (id=15751)

Could not rebase; Attempt merge onto 7148a257b2...

Updating 7148a257..87169bc8
Fast-forward
 docs/dev-info.rst             |   2 +
 docs/endpoints/collection.rst |   1 +
 docs/getting-started.rst      | 285 --------------------------
 docs/index.rst                |  25 ++-
 docs/spec-api.rst             |   4 +-
 docs/sys-info.rst             |   5 +-
 docs/user-manual.rst          | 461 ++++++++++++++++++++++++++++++++++++++++++
 7 files changed, 489 insertions(+), 294 deletions(-)
 delete mode 100644 docs/getting-started.rst
 create mode 100644 docs/user-manual.rst
Changes applied before test
commit 87169bc8a680ec6c0632f46590d489f528add4de
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Nov 9 15:57:28 2020 +0100

    Add an annotated table of content at the end of the introduction

commit 4af028e76d5bc67aa937579cfa1cc31ab41d0354
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Nov 2 14:52:15 2020 +0100

    doc: improve the user manual documentation
    
    - add an installation section (for swh deposit cli)
    - do not talk about the metadata-file-less deposit (it's a marginal use
      case that we do not encourage),
    - present the deposit workflow,
    - make it a step-by-step reproducible tutorial

commit a98bbbfad4cc5eb292bed0bc66058cfbd8232ad8
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Oct 28 09:58:04 2020 +0100

    doc: rename Getting Starter as User Manual and update the content

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

Harbormaster completed remote builds in B16963: Diff 15751.Nov 9 2020, 4:13 PM
vlorentz accepted this revision.Nov 9 2020, 4:40 PM
vlorentz added a subscriber: vlorentz.
vlorentz added inline comments.
docs/index.rst
68

s/you r/your/

This revision is now accepted and ready to land.Nov 9 2020, 4:40 PM
douardda updated this revision to Diff 15758.Nov 9 2020, 4:44 PM

typo (thx vlorentz)

swh-public-ci added a comment.Nov 9 2020, 4:47 PM

Build is green

Patch application report for D4450 (id=15758)

Could not rebase; Attempt merge onto 7148a257b2...

Updating 7148a257..5a401a5e
Fast-forward
 docs/dev-info.rst             |   2 +
 docs/endpoints/collection.rst |   1 +
 docs/getting-started.rst      | 285 --------------------------
 docs/index.rst                |  25 ++-
 docs/spec-api.rst             |   4 +-
 docs/sys-info.rst             |   5 +-
 docs/user-manual.rst          | 461 ++++++++++++++++++++++++++++++++++++++++++
 7 files changed, 489 insertions(+), 294 deletions(-)
 delete mode 100644 docs/getting-started.rst
 create mode 100644 docs/user-manual.rst
Changes applied before test
commit 5a401a5e3b657de148928913ea9a4c3681a624d9
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Nov 9 15:57:28 2020 +0100

    Add an annotated table of content at the end of the introduction

commit 4af028e76d5bc67aa937579cfa1cc31ab41d0354
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Nov 2 14:52:15 2020 +0100

    doc: improve the user manual documentation
    
    - add an installation section (for swh deposit cli)
    - do not talk about the metadata-file-less deposit (it's a marginal use
      case that we do not encourage),
    - present the deposit workflow,
    - make it a step-by-step reproducible tutorial

commit a98bbbfad4cc5eb292bed0bc66058cfbd8232ad8
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Oct 28 09:58:04 2020 +0100

    doc: rename Getting Starter as User Manual and update the content

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

Harbormaster completed remote builds in B16970: Diff 15758.Nov 9 2020, 4:47 PM
douardda updated this revision to Diff 15779.Nov 10 2020, 2:44 PM

rebase

swh-public-ci added a comment.Nov 10 2020, 2:48 PM

Build is green

Patch application report for D4450 (id=15779)

Could not rebase; Attempt merge onto 018500c195...

Removing docs/getting-started.rst
Merge made by the 'recursive' strategy.
 docs/dev-info.rst             |   2 +
 docs/endpoints/collection.rst |   1 +
 docs/getting-started.rst      | 285 -----------------------------
 docs/index.rst                |  25 ++-
 docs/spec-api.rst             |   4 +-
 docs/sys-info.rst             |   5 +-
 docs/user-manual.rst          | 411 ++++++++++++++++++++++++++++++++++++++++++
 7 files changed, 439 insertions(+), 294 deletions(-)
 delete mode 100644 docs/getting-started.rst
 create mode 100644 docs/user-manual.rst
Changes applied before test
commit 572d12f1a2408a624b372e2bf0fa92c07b6a118e
Merge: 018500c1 4ccdd16a
Author: Jenkins user <jenkins@localhost>
Date:   Tue Nov 10 13:46:14 2020 +0000

    Merge branch 'diff-target' into HEAD

commit 4ccdd16a9f866df114cbc52665bcf247d5ca03a3
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Nov 9 15:57:28 2020 +0100

    Add an annotated table of content at the end of the introduction

commit 60690ae9e5ff0b54d5885a7eedb9c22e27a5205f
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Nov 2 14:52:15 2020 +0100

    doc: improve the user manual documentation
    
    - add an installation section (for swh deposit cli)
    - do not talk about the metadata-file-less deposit (it's a marginal use
      case that we do not encourage),
    - present the deposit workflow,
    - make it a step-by-step reproducible tutorial

commit a98bbbfad4cc5eb292bed0bc66058cfbd8232ad8
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Oct 28 09:58:04 2020 +0100

    doc: rename Getting Starter as User Manual and update the content

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

Harbormaster completed remote builds in B16990: Diff 15779.Nov 10 2020, 2:48 PM
douardda updated this revision to Diff 15785.Nov 10 2020, 2:52 PM

rebase

swh-public-ci added a comment.Nov 10 2020, 3:03 PM

Build is green

Patch application report for D4450 (id=15785)

Could not rebase; Attempt merge onto 018500c195...

Updating 018500c1..c815bbf1
Fast-forward
 docs/dev-info.rst             |   2 +
 docs/endpoints/collection.rst |   1 +
 docs/getting-started.rst      | 285 -----------------------------
 docs/index.rst                |  25 ++-
 docs/spec-api.rst             |   4 +-
 docs/sys-info.rst             |   5 +-
 docs/user-manual.rst          | 411 ++++++++++++++++++++++++++++++++++++++++++
 7 files changed, 439 insertions(+), 294 deletions(-)
 delete mode 100644 docs/getting-started.rst
 create mode 100644 docs/user-manual.rst
Changes applied before test
commit c815bbf19a61390f1d216b8c11ef2f54ea5c2fcb
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Nov 9 15:57:28 2020 +0100

    Add an annotated table of content at the end of the introduction

commit a252e005acb19c3b3c2c77d7455cd8bed2a8f4bb
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Nov 2 14:52:15 2020 +0100

    doc: improve the user manual documentation
    
    - add an installation section (for swh deposit cli)
    - do not talk about the metadata-file-less deposit (it's a marginal use
      case that we do not encourage),
    - present the deposit workflow,
    - make it a step-by-step reproducible tutorial

commit 91f92a12d4555f895e47f5e717c667842ac97bc5
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Oct 28 09:58:04 2020 +0100

    doc: rename Getting Starter as User Manual and update the content

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

Harbormaster completed remote builds in B16996: Diff 15785.Nov 10 2020, 3:03 PM
Closed by commit rDDEPc815bbf19a61: Add an annotated table of content at the end of the introduction (authored by douardda). · Explain WhyNov 10 2020, 3:50 PM
This revision was automatically updated to reflect the committed changes.
douardda added a commit: rDDEPc815bbf19a61: Add an annotated table of content at the end of the introduction.

Revision Contents
Changeset List

PathSize
docs/
2 lines
endpoints/
1 line
20 lines
4 lines
5 lines

Diff 15785

View Options

docs/dev-info.rst

Loading...
View Options

docs/endpoints/collection.rst

Loading...
View Options

docs/index.rst

Loading...
View Options

docs/spec-api.rst

Loading...
View Options

docs/sys-info.rst

Loading...
About · Developer information · Legal