From 0e1b1cedc8022564ba76b06490b89738d0e746ad Mon Sep 17 00:00:00 2001
From: Moul <moul@moul.re>
Date: Tue, 17 Dec 2024 16:24:26 +0100
Subject: [PATCH] Move doc in contributing folder (#433)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Adapt paths, coverage can’t be moved
---
README.md | 2 +-
docs/blog/posts/v0.10.0.md | 2 +-
docs/blog/posts/v0.10.0rc.md | 2 +-
docs/blog/posts/v0.11.0rc0.md | 2 +-
docs/blog/posts/v0.8.md | 2 +-
docs/{ => contributing}/container_usage.md | 0
docs/{ => contributing}/documentation.md | 0
docs/{contributing.md => contributing/index.md} | 14 +++++++-------
docs/{ => contributing}/install_poetry.md | 2 +-
docs/{ => contributing}/testing.md | 0
docs/install.md | 2 +-
mkdocs.yml | 10 +++++-----
12 files changed, 19 insertions(+), 19 deletions(-)
rename docs/{ => contributing}/container_usage.md (100%)
rename docs/{ => contributing}/documentation.md (100%)
rename docs/{contributing.md => contributing/index.md} (92%)
rename docs/{ => contributing}/install_poetry.md (93%)
rename docs/{ => contributing}/testing.md (100%)
diff --git a/README.md b/README.md
index 61d65d23..783f1546 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 1d938e21..3783b084 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 3d69dd9d..145eebd9 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 4974a34d..05c340ea 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 d59d95a7..3b81ed51 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 d4724d14..7982f0c8 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 d57a9262..a4e465ad 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 c653986f..51dbff88 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 03e3a04b..95d6998d 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:
--
GitLab