Skip to content
Snippets Groups Projects
Commit 0e1b1ced authored by Moul's avatar Moul
Browse files

Move doc in contributing folder (#433)

Adapt paths, coverage can’t be moved
parent f3853497
No related branches found
No related tags found
1 merge request!271Set up new website structure with MkDocs (#433)
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
File moved
File moved
......@@ -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>
[![DuniterPy logo](images/duniterpy_logo.png){: style="height:150px;width:150px"}](https://git.duniter.org/clients/python/duniterpy)
[![DuniterPy logo](../images/duniterpy_logo.png){: 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>
[![Pre-commit logo](images/pre-commit_logo.svg){: style="height:150px;width:150px"}](https://pre-commit.com/)
[![Pre-commit logo](../images/pre-commit_logo.svg){: 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>
[![Pytest logo](images/pytest_logo.svg){: style="height:150px;width:150px"}](https://pytest.org)
[![Pytest logo](../images/pytest_logo.svg){: 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>
[![PyPI logo](images/pypi_logo.svg){: style="height:150px;width:150px"}](https://pypi.org/project/silkaj)
[![PyPI logo](../images/pypi_logo.svg){: 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>
![GitLab logo](images/GitLab_icon.svg){: style="height:100px;width:100px"}
![GitLab logo](../images/GitLab_icon.svg){: style="height:100px;width:100px"}
</center>
### Own built Docker images
......
<center>
![Poetry logo](images/poetry-logo.svg){: style="height:120px;width:120px"}
![Poetry logo](../images/poetry-logo.svg){: style="height:120px;width:120px"}
</center>
## Install Silkaj in a development environement with Poetry
......
File moved
......@@ -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/).
......@@ -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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment