Related to swh/meta#5075.

it's not ready to be published.

The idea is to generalize the fact that all the swh packages should have
a README file in the root directory, but this should be included in the
sphinx documentation, for which the simplest way is to make the file
symlinked in docs/. For several reasons, it's simpler to make this
symlink creation handled by a hook/automation script at doc build time
rather than add the symlink in the git repo of the swh package.

Antoine Lambert authored 2 years ago and Antoine Lambert committed 1 year ago

It was excluded a couple of years ago as no relevant Python code was
contained in that package but this is no longer the case.

This is not only used by the scheduler, and referencing the full range
of upstream settings may be useful.

So CLI documentation can link to it instead of repeating the whole
configuration of each block.

Related to swh/devel/swh-web#4746

Refs. swh/infra/sysadm-environment#4813

Make clear that the “API reference” page is an index of our modules.
Add a pointer to the “interface” part of the landing page for people
wanting to learn how to interact with Software Heritage.

Closes #4740

Related to #4732

Now we have switched to GitLab, code review is done via merge requests.
Update the process to the new terminology and provided tools.

Let’s also move the `patch-submission` ref from the obsolete Phabricator
page to the one about GitLab.

Related to #4732

As we have switched from Phabricator to GitLab, we now point at GitLab
documentation on how to automatically link and close issues from
commit messages.

Improvements on the section about commit messages are thrown in for good
measure.

Related to #4732

Related to swh/meta#4960

It is no longer included in the doc toc.

Remove the reference to phabricator

There are plenty of other phabricator links in another places in the
doc, but this ones are the first encountered by a new comer.

Related to swh/devel/swh-docs#4732

Suggested by @zack: “it's useful to have it on top (because a lot people
use docs.s.o for that, at least now), but it also belongs to devel doc,
so people will look for it on the left as well”