Differential D5339

docs: Unify READMEs in the documentation and the source code
ClosedPublic
Actions

Authored by ardumont on Mar 25 2021, 3:57 PM.

Details

Reviewers

moranegg

Group Reviewers

Reviewers

Commits

rDDEP59adffc64d04: docs: Unify READMEs in the documentation and the source code

Summary

This merges the old README.md into the docs/README.rst.
And creates a link README.rst into the repository top-level.

The main docs/README.rst was only visible from the docs.s.o site.
Now it's seen both in the git clone and the docs.

Test Plan

make docs is happy
(some warnings but it's local, they won't be warnings when built from swh-docs).

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

ardumont created this revision.Mar 25 2021, 3:57 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptMar 25 2021, 3:57 PM

ardumont published this revision for review.Mar 25 2021, 3:57 PM

Build is green

Patch application report for D5339 (id=19139)

Rebasing onto 3badd73107...

Current branch diff-target is up to date.

Changes applied before test

commit 21cc8e7d6779ba1a6ccbda9ccacc7e58a07032b6
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Thu Mar 25 15:43:44 2021 +0100

    docs: Unify READMEs in the documentation and the source code

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

Harbormaster completed remote builds in B20223: Diff 19139.Mar 25 2021, 3:59 PM

moranegg accepted this revision.Mar 25 2021, 4:02 PM

moranegg added a subscriber: moranegg.

moranegg added inline comments.

docs/README.rst
50	delete s on artifacts

This revision is now accepted and ready to land.Mar 25 2021, 4:02 PM

Fix typo

Build is green

Patch application report for D5339 (id=19141)

Rebasing onto 3badd73107...

Current branch diff-target is up to date.

Changes applied before test

commit 59adffc64d0426650dbcddd415d10751ab93af5e
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Thu Mar 25 15:43:44 2021 +0100

    docs: Unify READMEs in the documentation and the source code

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

Harbormaster completed remote builds in B20224: Diff 19141.Mar 25 2021, 4:07 PM

Closed by commit rDDEP59adffc64d04: docs: Unify READMEs in the documentation and the source code (authored by ardumont). · Explain WhyMar 25 2021, 4:09 PM

This revision was automatically updated to reflect the committed changes.

ardumont added a commit: rDDEP59adffc64d04: docs: Unify READMEs in the documentation and the source code.