Page MenuHomeSoftware Heritage
Differential D6428

docs: Add a save forge documentation
ClosedPublic
Actions

Authored by ardumont on Oct 6 2021, 6:43 PM.

Details

Reviewers
douardda
Group Reviewers
Reviewers
System administrators
Maniphest Tasks
T3629: doc: Add a "how to save a forge" as in how it's currently done
Commits
rDLS1a9c08c93feb: docs: Add a save forge documentation
Summary

This does not yet enter into the registration of a new lister task type (see D6438).

Related to T3629

Diff Detail

Repository
rDLS Listers
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 24295
Build 37919: Phabricator diff pipeline on jenkinsJenkins console · Jenkins
Build 37918: arc lint + arc unit

Event Timeline

ardumont created this revision.Oct 6 2021, 6:43 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptOct 6 2021, 6:43 PM
swh-public-ci added a comment.Oct 6 2021, 6:46 PM

Build is green

Patch application report for D6428 (id=23352)

Could not rebase; Attempt merge onto e7716c0122...

Updating e7716c0..1495a0c
Fast-forward
 ...n_a_new_lister.rst => develop_a_new_lister.rst} |   0
 docs/index.rst                                     |   3 +-
 docs/run_lister.rst                                | 296 +++++++++++++++++++++
 3 files changed, 298 insertions(+), 1 deletion(-)
 rename docs/{run_a_new_lister.rst => develop_a_new_lister.rst} (100%)
 create mode 100644 docs/run_lister.rst
Changes applied before test
commit 1495a0c70303cc9de6756c0560d05038eb6e59f4
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:42:20 2021 +0200

    docs: Transpose intranet docs on deploying a lister into sphinx doc
    
    This does more than explain how to save a new forge in production/staging. This needs to
    be evolved to also explain how to run it through docker (in another diff).
    
    Related to T3629

commit af7deeb42f093cd7436a62f0b58047228db6780d
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:32:29 2021 +0200

    docs: Rename run a new lister doc into develop a new lister
    
    There is mostly references on how actually develop a new lister
    
    Related to T3629

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

Harbormaster completed remote builds in B24268: Diff 23352.Oct 6 2021, 6:46 PM
ardumont requested review of this revision.Oct 6 2021, 6:46 PM
ardumont edited the summary of this revision. (Show Details)Oct 7 2021, 8:36 AM
ardumont added a reviewer: System administrators.
ardumont updated this revision to Diff 23376.Oct 7 2021, 3:23 PM

Just concentrate on save forge for now

ardumont retitled this revision from docs: Transpose intranet docs on deploying a lister into sphinx doc to docs: Add a save forge documentation.Oct 7 2021, 3:23 PM
ardumont edited the summary of this revision. (Show Details)
swh-public-ci added a comment.Oct 7 2021, 3:26 PM

Build is green

Patch application report for D6428 (id=23376)

Could not rebase; Attempt merge onto e7716c0122...

Updating e7716c0..a1278d6
Fast-forward
 ...n_a_new_lister.rst => develop_a_new_lister.rst} |  0
 docs/index.rst                                     |  3 +-
 docs/save_forge.rst                                | 54 ++++++++++++++++++++++
 3 files changed, 56 insertions(+), 1 deletion(-)
 rename docs/{run_a_new_lister.rst => develop_a_new_lister.rst} (100%)
 create mode 100644 docs/save_forge.rst
Changes applied before test
commit a1278d63f52e92de85496d3c0fb66edf33280939
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:42:20 2021 +0200

    docs: Add a save forge documentation
    
    This does not yet enter into the registration of a new lister.
    
    Related to T3629

commit af7deeb42f093cd7436a62f0b58047228db6780d
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:32:29 2021 +0200

    docs: Rename run a new lister doc into develop a new lister
    
    There is mostly references on how actually develop a new lister
    
    Related to T3629

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

Harbormaster completed remote builds in B24293: Diff 23376.Oct 7 2021, 3:26 PM
ardumont updated this revision to Diff 23377.Oct 7 2021, 3:27 PM

Rewrote sentences

ardumont updated this revision to Diff 23378.Oct 7 2021, 3:30 PM

Rebase

swh-public-ci added a comment.Oct 7 2021, 3:30 PM

Build is green

Patch application report for D6428 (id=23377)

Could not rebase; Attempt merge onto e7716c0122...

Updating e7716c0..fe44c27
Fast-forward
 ...n_a_new_lister.rst => develop_a_new_lister.rst} |  0
 docs/index.rst                                     |  3 +-
 docs/save_forge.rst                                | 54 ++++++++++++++++++++++
 3 files changed, 56 insertions(+), 1 deletion(-)
 rename docs/{run_a_new_lister.rst => develop_a_new_lister.rst} (100%)
 create mode 100644 docs/save_forge.rst
Changes applied before test
commit fe44c27a2b3e63dac3cd610e4780583a4e28d8d6
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:42:20 2021 +0200

    docs: Add a save forge documentation
    
    This does not yet enter into the registration of a new lister.
    
    Related to T3629

commit af7deeb42f093cd7436a62f0b58047228db6780d
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:32:29 2021 +0200

    docs: Rename run a new lister doc into develop a new lister
    
    There is mostly references on how actually develop a new lister
    
    Related to T3629

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

Harbormaster completed remote builds in B24295: Diff 23377.Oct 7 2021, 3:30 PM
swh-public-ci added a comment.Oct 7 2021, 3:33 PM

Build is green

Patch application report for D6428 (id=23378)

Rebasing onto e7716c0122...

Current branch diff-target is up to date.
Changes applied before test
commit 2d7bb6dc9f5cdbebf943833a6e2dcf63f6b8e9c4
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:42:20 2021 +0200

    docs: Add a save forge documentation
    
    This does not yet enter into the registration of a new lister.
    
    Related to T3629

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

Harbormaster completed remote builds in B24296: Diff 23378.Oct 7 2021, 3:33 PM
ardumont updated this revision to Diff 23380.Oct 7 2021, 3:43 PM

Adapt links

ardumont added a child revision: D6438: docs: Explain task type registering to complete the save forge doc.Oct 7 2021, 3:43 PM
swh-public-ci added a comment.Oct 7 2021, 3:46 PM

Build is green

Patch application report for D6428 (id=23380)

Rebasing onto e7716c0122...

Current branch diff-target is up to date.
Changes applied before test
commit 463b01879170c652ee21e6af7484f70757978d54
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:42:20 2021 +0200

    docs: Add a save forge documentation
    
    This does not yet enter into the registration of a new lister.
    
    Related to T3629

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

Harbormaster completed remote builds in B24298: Diff 23380.Oct 7 2021, 3:46 PM
ardumont edited the summary of this revision. (Show Details)Oct 7 2021, 3:50 PM
ardumont updated this revision to Diff 23396.Oct 8 2021, 1:43 PM

Fix cli wrap around ``

swh-public-ci added a comment.Oct 8 2021, 1:46 PM

Build is green

Patch application report for D6428 (id=23396)

Rebasing onto e7716c0122...

Current branch diff-target is up to date.
Changes applied before test
commit bfe4e57649919f7667a74db3e094e30d4b02e721
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:42:20 2021 +0200

    docs: Add a save forge documentation
    
    This does not yet enter into the registration of a new lister.
    
    Related to T3629

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

Harbormaster completed remote builds in B24313: Diff 23396.Oct 8 2021, 1:46 PM
douardda accepted this revision.Oct 8 2021, 2:49 PM
douardda added a subscriber: douardda.

Ok but see my 2 (nitpicky) comments

docs/save_forge.rst
6

unneeded (IMHO)

6

Why "first" here? what is the second step this "first" calls?

This revision is now accepted and ready to land.Oct 8 2021, 2:49 PM
ardumont updated this revision to Diff 23411.Oct 8 2021, 4:03 PM

Adapt according to suggestion

swh-public-ci added a comment.Oct 8 2021, 4:07 PM

Build is green

Patch application report for D6428 (id=23411)

Rebasing onto e7716c0122...

Current branch diff-target is up to date.
Changes applied before test
commit 430b48ebd2890e14825dab7fda6bf9f9341470db
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:42:20 2021 +0200

    docs: Add a save forge documentation
    
    This does not yet enter into the registration of a new lister.
    
    Related to T3629

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

Harbormaster completed remote builds in B24327: Diff 23411.Oct 8 2021, 4:07 PM
ardumont updated this revision to Diff 23413.Oct 8 2021, 4:07 PM

Fix typo

docs/save_forge.rst
6

The other instructions probably got dopped and i forgot to drop the first here.

swh-public-ci added a comment.Oct 8 2021, 4:10 PM

Build is green

Patch application report for D6428 (id=23413)

Rebasing onto e7716c0122...

Current branch diff-target is up to date.
Changes applied before test
commit 1a9c08c93feb2903a1fdf2bfc3378d383a9d3e03
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 6 18:42:20 2021 +0200

    docs: Add a save forge documentation
    
    This does not yet enter into the registration of a new lister.
    
    Related to T3629

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

Harbormaster completed remote builds in B24329: Diff 23413.Oct 8 2021, 4:10 PM
Closed by commit rDLS1a9c08c93feb: docs: Add a save forge documentation (authored by ardumont). · Explain WhyOct 8 2021, 5:17 PM
This revision was automatically updated to reflect the committed changes.
ardumont added a commit: rDLS1a9c08c93feb: docs: Add a save forge documentation.

Revision Contents
Changeset List

PathSize
docs/
1 line
54 lines

Diff 23377

View Options

docs/index.rst

Loading...
View Options

docs/save_forge.rst

Loading...
About · Developer information · Legal