Page MenuHomeSoftware Heritage
Differential D8199

Add a 'user' documentation entry for the Crates lister. Add myself as contributor
AbandonedPublic
Actions

Authored by franckbret on Aug 5 2022, 12:17 PM.

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Maniphest Tasks
T4104: Ingest crates.io (Rust)
Summary

Related T4104

Diff Detail

Event Timeline

franckbret created this revision.Aug 5 2022, 12:17 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptAug 5 2022, 12:17 PM
swh-public-ci added a comment.Aug 5 2022, 12:19 PM

Build has FAILED

Patch application report for D8199 (id=29580)

Rebasing onto a83766debd...

Current branch diff-target is up to date.
Changes applied before test
commit 05f838aaa4864b418d6b66d6eec3fcd0744e061c
Author: Franck Bret <franck.bret@octobus.net>
Date:   Fri Aug 5 12:12:46 2022 +0200

    Add a 'user' documentation entry for the Crates lister.
    
    Related T4104

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

Harbormaster returned this revision to the author for changes because remote builds failed.Aug 5 2022, 12:20 PM
Harbormaster failed remote builds in B30646: Diff 29580!
ardumont added a subscriber: ardumont.Aug 5 2022, 1:35 PM

Nice, thanks.

A couple of typos to fix inline.

user/listers/crates.rst
19
20
30
42
43
48
ardumont added inline comments.Aug 5 2022, 1:37 PM
user/listers/crates.rst
47

build failure is not happy about this one [1] [2]

[1]

12:19:57  /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/user/listers/crates.rst:48: ERROR: Unknown target name: "original-artifacts-json specification".

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

swh-public-ci added a comment.Aug 5 2022, 1:38 PM

Build has FAILED

Patch application report for D8199 (id=29580)

Rebasing onto a83766debd...

Current branch diff-target is up to date.
Changes applied before test
commit 05f838aaa4864b418d6b66d6eec3fcd0744e061c
Author: Franck Bret <franck.bret@octobus.net>
Date:   Fri Aug 5 12:12:46 2022 +0200

    Add a 'user' documentation entry for the Crates lister.
    
    Related T4104

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

ardumont added a comment.Aug 5 2022, 1:38 PM

Build has failed

See this line which the build is not happy about [1]

[1] https://forge.softwareheritage.org/D8199#inline-58335

ardumont mentioned this in T4104: Ingest crates.io (Rust).Aug 5 2022, 1:45 PM
ardumont added a comment.Aug 5 2022, 1:52 PM

also, I cannot accept it yet (the build needs to pass first ;)

franckbret updated this revision to Diff 29595.Aug 5 2022, 2:47 PM
franckbret marked 7 inline comments as done.

Fix typos and an hyperlink

franckbret added a comment.Aug 5 2022, 2:48 PM

@ardumont Thanks for your feedback

swh-public-ci added a comment.Aug 5 2022, 2:59 PM

Build is green

Patch application report for D8199 (id=29595)

Rebasing onto a83766debd...

Current branch diff-target is up to date.
Changes applied before test
commit 880293b9754eb19e464624e54a4be5a63bc1266d
Author: Franck Bret <franck.bret@octobus.net>
Date:   Fri Aug 5 12:12:46 2022 +0200

    Add a 'user' documentation entry for the Crates lister.
    
    Related T4104

See https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/204/ for more details.

Harbormaster completed remote builds in B30659: Diff 29595.Aug 5 2022, 2:59 PM
franckbret requested review of this revision.Aug 5 2022, 2:59 PM
vlorentz added a subscriber: vlorentz.Aug 5 2022, 3:15 PM
vlorentz added inline comments.
user/listers/crates.rst
30

"envelope", actually; "envelop" is a verb.

But I don't understand what it is supposed to mean. Why not "schema" or "keys"?

46

This is an internal link

71
113

see above

franckbret updated this revision to Diff 29596.Aug 5 2022, 3:27 PM
franckbret marked 3 inline comments as done.

Some more typos, replace a link with an internal ref

Updating D8199: Add a 'user' documentation entry for the Crates lister.

Add myself as contributor

franckbret marked an inline comment as done.Aug 5 2022, 3:28 PM
swh-public-ci added a comment.Aug 5 2022, 3:30 PM

Build has FAILED

Patch application report for D8199 (id=29596)

Rebasing onto a83766debd...

Current branch diff-target is up to date.
Changes applied before test
commit 25f86a1e503e893f2c238749d3e52f5ffffa8d22
Author: Franck Bret <franck.bret@octobus.net>
Date:   Fri Aug 5 12:12:46 2022 +0200

    Add a 'user' documentation entry for the Crates lister.
    
    Related T4104

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

Harbormaster failed remote builds in B30661: Diff 29596!Aug 5 2022, 3:30 PM
vlorentz accepted this revision.Aug 5 2022, 3:39 PM
This revision is now accepted and ready to land.Aug 5 2022, 3:39 PM
franckbret updated this revision to Diff 29597.Aug 5 2022, 3:46 PM

Try to fix internal ref link

swh-public-ci added a comment.Aug 5 2022, 3:50 PM

Build has FAILED

Patch application report for D8199 (id=29597)

Rebasing onto a83766debd...

Current branch diff-target is up to date.
Changes applied before test
commit b8c8e177fd4a622772843763887b90b537478b62
Author: Franck Bret <franck.bret@octobus.net>
Date:   Fri Aug 5 12:12:46 2022 +0200

    Add a 'user' documentation entry for the Crates lister.
    
    Related T4104

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

Harbormaster failed remote builds in B30662: Diff 29597!Aug 5 2022, 3:50 PM
franckbret updated this revision to Diff 29598.Aug 5 2022, 4:07 PM

Try again to fix the internal hyperlink to a section, this time replace \# with \:

Updating D8199: Add a 'user' documentation entry for the Crates lister.

Add myself as contributor

swh-public-ci added a comment.Aug 5 2022, 4:10 PM

Build has FAILED

Patch application report for D8199 (id=29598)

Rebasing onto a83766debd...

Current branch diff-target is up to date.
Changes applied before test
commit 92c8629bd8fdd3eeef0a5216074639456bffe3ce
Author: Franck Bret <franck.bret@octobus.net>
Date:   Fri Aug 5 12:12:46 2022 +0200

    Add a 'user' documentation entry for the Crates lister.
    
    Related T4104

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

Harbormaster failed remote builds in B30663: Diff 29598!Aug 5 2022, 4:10 PM
franckbret added inline comments.Aug 5 2022, 4:21 PM
user/listers/crates.rst
46

What should be the correct syntax to reference a section in another document?

I tried those but it still fails building.

<extrinsic-metadata-specification#original-artifacts-json>
<extrinsic-metadata-specification:original-artifacts-json>

vlorentz added inline comments.Aug 5 2022, 4:24 PM
user/listers/crates.rst
46

just <original-artifacts-json>

franckbret updated this revision to Diff 29600.Aug 5 2022, 4:31 PM

Fix hyperlink, only the reference to named anchor is needed

swh-public-ci added a comment.Aug 5 2022, 4:34 PM

Build has FAILED

Patch application report for D8199 (id=29600)

Rebasing onto a83766debd...

Current branch diff-target is up to date.
Changes applied before test
commit 464f848b9e82c71bff510baea3422055b055db72
Author: Franck Bret <franck.bret@octobus.net>
Date:   Fri Aug 5 12:12:46 2022 +0200

    Add a 'user' documentation entry for the Crates lister.
    
    Related T4104

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

Harbormaster failed remote builds in B30665: Diff 29600!Aug 5 2022, 4:34 PM
franckbret marked an inline comment as done.Aug 5 2022, 4:44 PM
franckbret added inline comments.
user/listers/crates.rst
46

It still fail.

/var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/user/listers/crates.rst:47: WARNING: undefined label: original-artifacts-json

By the way what is the quick way to check for errors within my venv?

I've tried with make docs but it fails, make all too. Looks like it complains about svg files and dia. Do I need to install dia or is it unexpected?

vlorentz added inline comments.Aug 5 2022, 5:24 PM
user/listers/crates.rst
46
/var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/user/listers/crates.rst:47: WARNING: undefined label: original-artifacts-json

original-artifacts-json is defined in a different git repo, but this shouldn't be an issue. Hmm.....

By the way what is the quick way to check for errors within my venv?

Jenkins runs tox -e sphinx-dev

vlorentz added inline comments.Aug 5 2022, 5:27 PM
user/listers/crates.rst
46

OH, I got it. it's because you added this to the user documentation. We could add an inter-sphinx link, but I'd rather you move this to developer documentation instead; this page only contains technical details that aren't useful to end users.

franckbret marked an inline comment as done.Aug 8 2022, 8:38 AM
franckbret added inline comments.
user/listers/crates.rst
46

Ah, ok.
What should be the path of that file?

vlorentz added inline comments.Aug 8 2022, 9:51 AM
user/listers/crates.rst
46

Make it a module docstring in swh/listers/crates/__init__.py so it shows up on https://docs.softwareheritage.org/devel/apidoc/swh.lister.crates.html which is linked from https://docs.softwareheritage.org/user/listers/index.html

franckbret mentioned this in D8206: crates: Add a developer documentation at module level.Aug 8 2022, 10:17 AM
franckbret marked an inline comment as done.Aug 8 2022, 10:24 AM
franckbret added inline comments.
user/listers/crates.rst
46

Ok, I moved it to module level, see D8206

franckbret mentioned this in rDLS751c3df1b7aa: crates: Add a developer documentation at module level.Aug 8 2022, 3:09 PM
franckbret abandoned this revision.Aug 8 2022, 3:24 PM
franckbret marked an inline comment as done.

Abandonning this one as the same content has been moved to crates lister module docstring ( see D8206 )

bchauvet added a task: T4104: Ingest crates.io (Rust).Sep 30 2022, 10:21 AM

Revision Contents
Changeset List

PathSize
1 line
1 line
user/
listers/
111 lines

Diff 29596

View Options

.pre-commit-config.yaml

Loading...
View Options

CONTRIBUTORS

Loading...
View Options

user/listers/crates.rst

Loading...
About · Developer information · Legal