Related to swh-web#4746

Related to swh/meta#4960

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

These changes allow to build all SWH documentations (developmment, system
administration and user) using a single sphinx-build command, meaning they
are now merged into a single one with shared index of references.

Development documentation is now rooted to docs/devel, user one to docs/user
and sysadmin one to docs/sysadm so a good amount of files were moved.

A couple of configuration files and makefiles were updated to reflect that change
and the building / cleaning processes were made more reliable.

Calling make in root directory of swh-docs will execute the development build
of the documentation in a tox environment while calling make in docs folder
will use the current virtualenv.

It remains possible to build each documentation in a standalone way by
calling make in their root directory.

Closes #4496

Also ensure apt-transport-https package is installed.

Current debian stable (bullseye) does not package postgresql-autodoc
so remove it from packages list and add alternative install instructions.

yarnpkg debian package does not play well with nodejs installed from
nodesource so add instructions to install its latest version through
its homemade debian package.

- Use the generic `virtual environment` instead of `virtualenv` and
  point to the official Python documentation.
- Use the internal reference to the getting started doc.
- Mention there is tons of good tips in the documentation about
  the Docker environment.
- Update the link to the documentation on how to submit patches.

The `--now` flag to `systemctl disable` will stop (on top of disabling)
the given services. `systemctl disable` also accepts multiple services
as argument.

We can thus replace 4 commands in the developer setup documentation by a
single one.

This would warrant a more thorough guide, but I'm not the best person to
write such a guide, and this is better than having nothing.

Related to T4259

To avoid discrepancy with tox when pre-commit is triggered.

Fixed the broken link with the right file name.

Elasticsearch is required to work on swh-search component.

It is now required for swh-web frontend development.

The command is not always installed by default, for instance in the
debian:buster docker image.

Loïc Dachary authored 4 years ago and Stefano Zacchiroli committed 4 years ago

Closes T2946

Summary: Resolves T2917

Reviewers: #reviewers, zack

Maniphest Tasks: T2917

Differential Revision: https://forge.softwareheritage.org/D4796

Add rsync which was implicit dependency for docker dev setup.
Move comments so that the command is runnable as-is.

- postgresql-server-dev-all was overkill, postgresql libpq-dev suffice
- short description on deps grouped by role

They are needed for the documentation.

- pre-commit doesn't necessarily exist as a system package (i.e.
Debian buster), and is used as a Python library in swh git repos,
so install via pip in the virtualenv.
- install local swh packages as a 2-step process to avoid errors

Reviewers: #reviewers

Differential Revision: https://forge.softwareheritage.org/D3634

Summary:
If running this command on bullseye, there may already be a postgresql-12-server
installed; so pytest-postgresql will try to use postgresql-12's pg_ctl, which
does not exist.

Using the virtual package 'postgresql' instead of 'postgresql-11' installs
the right version for the distribution.

Reviewers: #reviewers, olasd

Differential Revision: https://forge.softwareheritage.org/D3631

Reviewers: #reviewers

Differential Revision: https://forge.softwareheritage.org/D3630

Related to T2367