diff --git a/README.md b/README.md index 61d65d2321f17abf85b2fa4cb1251c1942b23e32..783f1546059f5558e0010b90962e6dbf43fb4902 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ There is two kind of images. One build with `pip` for user purposes, and one usi ### For contributing purposes -- [Install the Poetry development environment](https://silkaj.duniter.org/install_poetry/) +- [Install the Poetry development environment](https://silkaj.duniter.org/contributing/install_poetry/) - Check out the [contributing guidelines](https://silkaj.duniter.org/contributing/) ## Usage diff --git a/docs/blog/posts/v0.10.0.md b/docs/blog/posts/v0.10.0.md index 1d938e216460c671c57526a01ca95a6ec013ba81..3783b084a637b1b2bbf53c93d3af41bea93c63e3 100644 --- a/docs/blog/posts/v0.10.0.md +++ b/docs/blog/posts/v0.10.0.md @@ -104,7 +104,7 @@ If you missed DeathReaper crowdfunding completion, you can check this [message]( The automated generation of Silkaj Docker images has been implemented in the first place to distribute DeathReaper. This is a new way to install Silkaj and its environment. This is convenient to distribute non-stable releases. -You can find the [documentation on how to use these images](/container_usage). +You can find the [documentation on how to use these images](/contributing/container_usage). ## Network diff --git a/docs/blog/posts/v0.10.0rc.md b/docs/blog/posts/v0.10.0rc.md index 3d69dd9dec33fc621391c3d89a3ef71009627b84..145eebd94d4473bb27b82195c9f2ab03662eb55c 100644 --- a/docs/blog/posts/v0.10.0rc.md +++ b/docs/blog/posts/v0.10.0rc.md @@ -24,7 +24,7 @@ To install the Python package, run following command: pip3 install silkaj --user --upgrade --pre ``` -To [install and run Silkaj from a container](/container_usage): +To [install and run Silkaj from a container](/contributing/container_usage): ``` sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.10.0rc0 diff --git a/docs/blog/posts/v0.11.0rc0.md b/docs/blog/posts/v0.11.0rc0.md index 4974a34d7310ce52df0f3e6a17272d38fba15c4a..05c340ea80d511394c56f6cceee5ade32f8d502e 100644 --- a/docs/blog/posts/v0.11.0rc0.md +++ b/docs/blog/posts/v0.11.0rc0.md @@ -29,7 +29,7 @@ sudo apt install pipx pipx install --pip-args "\--pre" silkaj ``` -To [install and run Silkaj from the container](/container_usage): +To [install and run Silkaj from the container](/contributing/container_usage): ``` sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.11.0rc0 diff --git a/docs/blog/posts/v0.8.md b/docs/blog/posts/v0.8.md index d59d95a76f4c30c55719379fefa817c1d56be360..3b81ed510844bf69a3703eb746103373718814ec 100644 --- a/docs/blog/posts/v0.8.md +++ b/docs/blog/posts/v0.8.md @@ -209,7 +209,7 @@ We migrated the packaging and the dependency management tool from Pipenv to Poet In comparison, [Poetry](https://python-poetry.org/) is a well thought and stable tool which has been released by the end of 2019. In the former development environment, we had to define the dependencies twice in the `requirements.txt`, `setup.{py,cfg}`, `Pipenv` files. Poetry, however, supports the `pyproject.toml` file standardized by the Python project and is able to define the dependencies at once. -If you would like to install Silkaj for development purposes, please follow [this tutorial](/install_poetry/). You may also interested by checking the newly introduced contribution process documentation `CONTRIBUTING.md`. +If you would like to install Silkaj for development purposes, please follow [this tutorial](/contributing/install_poetry/). You may also interested by checking the newly introduced contribution process documentation `CONTRIBUTING.md`. ### B. Automatic container generation diff --git a/docs/container_usage.md b/docs/contributing/container_usage.md similarity index 100% rename from docs/container_usage.md rename to docs/contributing/container_usage.md diff --git a/docs/documentation.md b/docs/contributing/documentation.md similarity index 100% rename from docs/documentation.md rename to docs/contributing/documentation.md diff --git a/docs/contributing.md b/docs/contributing/index.md similarity index 92% rename from docs/contributing.md rename to docs/contributing/index.md index d4724d14566fdefd78d0cb454fbc7e73692ab8b1..7982f0c8062ec995d9a017725a600e814d393b7f 100644 --- a/docs/contributing.md +++ b/docs/contributing/index.md @@ -6,7 +6,7 @@ Part of the Duniter project running the Äž1 currency, Silkaj project is aiming a ## Install the development environment -We are using [Poetry](https://python-poetry.org/) as a development environment solution. Start by [installing Poetry](/install_poetry/). +We are using [Poetry](https://python-poetry.org/) as a development environment solution. Start by [installing Poetry](/contributing/install_poetry/). This will install a sandboxed Python environment. Dependencies will be installed in it in order to have Silkaj running and to have pre-installed developement tools. @@ -23,7 +23,7 @@ Dependencies will be installed in it in order to have Silkaj running and to have ## Developing with DuniterPy <center> -[{: style="height:150px;width:150px"}](https://git.duniter.org/clients/python/duniterpy) +[{: style="height:150px;width:150px"}](https://git.duniter.org/clients/python/duniterpy) </center> [DuniterPy](https://git.duniter.org/clients/python/duniterpy) is a Python library for Duniter v1 clients. @@ -60,7 +60,7 @@ Please read their documentations on how to use them the best possible. ## Pre-commit hooks <center> -[{: style="height:150px;width:150px"}](https://pre-commit.com/) +[{: style="height:150px;width:150px"}](https://pre-commit.com/) </center> We are using [`pre-commit`](https://pre-commit.com/) tool to perform checks on staged changes before committing. @@ -124,10 +124,10 @@ Check out [duniterpy#169](https://git.duniter.org/clients/python/duniterpy/-/iss ## Tests <center> -[{: style="height:150px;width:150px"}](https://pytest.org) +[{: style="height:150px;width:150px"}](https://pytest.org) </center> -We are using [Pytest](https://pytest.org) as a tests framework. For more information on how Silkaj implements them check the [testing documentation](/testing/). +We are using [Pytest](https://pytest.org) as a tests framework. For more information on how Silkaj implements them check the [testing documentation](/contributing/testing/). Tests are stored into `unit` and `integration` folders depending on their types, then using a similar tree as the source code. @@ -181,7 +181,7 @@ Only difference is to update the year in `license_header.txt` rather than `LICEN ## PyPI and PyPI test distributions <center> -[{: style="height:150px;width:150px"}](https://pypi.org/project/silkaj) +[{: style="height:150px;width:150px"}](https://pypi.org/project/silkaj) </center> Silkaj is distributed to PyPI, the Python Package Index, for further `pip` installation. @@ -218,7 +218,7 @@ The `--extra-index-url` is used to retrieve dependencies packages from the offic ## Continuous integration and delivery <center> -{: style="height:100px;width:100px"} +{: style="height:100px;width:100px"} </center> ### Own built Docker images diff --git a/docs/install_poetry.md b/docs/contributing/install_poetry.md similarity index 93% rename from docs/install_poetry.md rename to docs/contributing/install_poetry.md index d57a9262e0f9b812bdc40688594fe085f4a68fea..a4e465ad6d3522bc567bab92cfabe5763741d1bc 100644 --- a/docs/install_poetry.md +++ b/docs/contributing/install_poetry.md @@ -1,5 +1,5 @@ <center> -{: style="height:120px;width:120px"} +{: style="height:120px;width:120px"} </center> ## Install Silkaj in a development environement with Poetry diff --git a/docs/testing.md b/docs/contributing/testing.md similarity index 100% rename from docs/testing.md rename to docs/contributing/testing.md diff --git a/docs/install.md b/docs/install.md index c653986fe76776f539df921536feafb24cd5dfa1..51dbff88785d99f7f8ee60c05f03a97b125dce59 100644 --- a/docs/install.md +++ b/docs/install.md @@ -145,4 +145,4 @@ silkaj ## Install to contribute -Check out the [installation guide with Poetry](/install_poetry). +Check out the [installation guide with Poetry](/contributing/install_poetry/). diff --git a/mkdocs.yml b/mkdocs.yml index 03e3a04bbb7da487448bb616108a803c32a90291..95d6998d2d6f5a1fbde30924860934012e1c5191 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -56,11 +56,11 @@ nav: - blog/index.md - Changelog: changelog.md - Contributing: - - contributing.md - - Poetry installation: install_poetry.md - - Container usage: container_usage.md - - Documentation: documentation.md - - Testing: testing.md + - contributing/index.md + - Poetry installation: contributing/install_poetry.md + - Container usage: contributing/container_usage.md + - Documentation: contributing/documentation.md + - Testing: contributing/testing.md - Coverage report: coverage.md extra: