Page MenuHomeSoftware Heritage

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

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

Details

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
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 20223
Build 31386: Phabricator diff pipeline on jenkinsJenkins console · Jenkins
Build 31385: arc lint + arc unit

Event Timeline

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.

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

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.