commit f798084f1731c788374d6e563be74a58782a3f7d Author: juga0 juga@riseup.net Date: Fri Jun 26 08:21:26 2020 +0000
fix: doc: Replace docs links from Github to Gitlab --- DEPLOY.rst | 14 +++++++------- INSTALL.rst | 2 +- README.md | 14 +++++++------- 3 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/DEPLOY.rst b/DEPLOY.rst index 45e9d31..b5145c0 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -36,8 +36,8 @@ destination IP closer to the scanner exit. scanner setup ----------------------
-Install sbws according to `<INSTALL.rst>`_ (in the local directory or GitHub) -or `<INSTALL.html>`_ (local build or Read the Docs). +Install sbws according to `<INSTALL.rst>`_ (in the local directory or Tor +Project Gitlab) or `<INSTALL.html>`_ (local build or Read the Docs).
To run the ``scanner`` it is mandatory to create a configuration file with at least one ``destination``. @@ -57,12 +57,12 @@ If ``sbws`` is installed from the sources as a non-root user then create the configuration file in ``~/.sbws.ini``.
More details about the configuration file can be found in -``./docs/source/man_sbws.ini.rst`` (in the local directory or GitHub) or -`<man_sbws.ini.html>`_ (local build or Read the Docs) or +``./docs/source/man_sbws.ini.rst`` (in the local directory or Tor Project +Gitlab) or `<man_sbws.ini.html>`_ (local build or Read the Docs) or ``man sbws.ini`` (system package).
-See also ``./docs/source/man_sbws.rst`` (in the local directory or GitHub) or -`<man_sbws.html>`_ (local build or Read the Docs) or ``man sbws`` (system -package). +See also ``./docs/source/man_sbws.rst`` (in the local directory or Tor Project +Gitlab) or `<man_sbws.html>`_ (local build or Read the Docs) or ``man sbws`` +(system package).
.. _Content delivery network: https://en.wikipedia.org/wiki/Content_delivery_network diff --git a/INSTALL.rst b/INSTALL.rst index 7bf57ca..19fc25f 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -76,7 +76,7 @@ Configuration and deployment
``sbws`` needs :term:`destination` s to request files from.
-Please, see `<DEPLOY.rst>`_ (in the local directory or GitHub) or +Please, see `<DEPLOY.rst>`_ (in the local directory or Tor Project Gitlab) or `<DEPLOY.html>`_ (local build or Read the Docs) to configure, deploy and run ``sbws``.
diff --git a/README.md b/README.md index e796e46..852d02c 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,8 @@ of the Tor bandwidth authorities, to avoid creating unnecessary traffic.
**ADVICE**: It is recommended to read this documentation at [Read the Docs](https://sbws.rtfd.io). In -[Github](https://github.com/torproject/sbws) some links won't be properly -rendered. +[Tor Project Gitlab](https://gitlab.torproject.org/tpo/network-health/sbws) +(tpo Gitlab) some links won't be properly rendered. It can also be read after installing the Debian package ``sbws-doc`` in ``/usr/share/doc/sbws`` or after building it locally as explained in ``./docs/source/documenting.rst``. @@ -33,19 +33,19 @@ It can also be read after installing the Debian package ``sbws-doc`` in Installing ------------
-See [./INSTALL.rst](INSTALL.rst) (in local directory or GitHub) or +See [./INSTALL.rst](INSTALL.rst) (in local directory or tpo Gitlab) or [INSTALL.html](INSTALL.html) (local build or Read the Docs).
Deploying and running ---------------------
-See [./DEPLOY.rst](DEPLOY.rst) (in local directory or GitHub) or +See [./DEPLOY.rst](DEPLOY.rst) (in local directory or tpo Gitlab) or [DEPLOY.html](DEPLOY.html) (local build or Read the Docs).
Changelog --------------
-See [./CHANGELOG.rst](CHANGELOG.rst) (in local directory or GitHub) or +See [./CHANGELOG.rst](CHANGELOG.rst) (in local directory or tpo Gitlab) or [CHANGELOG.html](CHANGELOG.html) (local build or Read the Docs).
Documentation @@ -66,5 +66,5 @@ software in ./LICENSE.md
## Authors
-See [./AUTHORS.md](AUTHORS.md) (in local directory or GitHub) or -[AUTHORS.html](AUTHORS.html) (local build or Read the Docs). \ No newline at end of file +See [./AUTHORS.md](AUTHORS.md) (in local directory or tpo Gitlab) or +[AUTHORS.html](AUTHORS.html) (local build or Read the Docs).