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

Fix internal links paths (#433)

Always use relative paths and .md extension
Fix link to md file in same dir by using relative "local" : "./"
parent 9d6659af
No related branches found
No related tags found
1 merge request!271Set up new website structure with MkDocs (#433)
...@@ -104,7 +104,7 @@ If you missed DeathReaper crowdfunding completion, you can check this [message]( ...@@ -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. 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. 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](/contributing/container_usage). You can find the [documentation on how to use these images](../../contributing/container_usage.md).
## Network ## Network
......
...@@ -24,7 +24,7 @@ To install the Python package, run following command: ...@@ -24,7 +24,7 @@ To install the Python package, run following command:
pip3 install silkaj --user --upgrade --pre pip3 install silkaj --user --upgrade --pre
``` ```
To [install and run Silkaj from a container](/contributing/container_usage): To [install and run Silkaj from a container](../../contributing/container_usage.md):
``` ```
sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.10.0rc0 sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.10.0rc0
......
...@@ -43,7 +43,7 @@ sudo apt install pipx libsodium23 ...@@ -43,7 +43,7 @@ sudo apt install pipx libsodium23
pipx install silkaj pipx install silkaj
``` ```
For a comprehensive documentation, check the [installation documentation](/install). For a comprehensive documentation, check the [installation documentation](../../install.md).
## New CLI design ## New CLI design
......
...@@ -22,14 +22,14 @@ It is planned to be the latest release with Duniter v1/BMA support and the relea ...@@ -22,14 +22,14 @@ It is planned to be the latest release with Duniter v1/BMA support and the relea
You can install this pre-release version from PyPI or from a Docker image. You can install this pre-release version from PyPI or from a Docker image.
To install the Python package, run following command: To install the Python package, run following command:
Install `pipx` from the [installation documentation](/install): Install `pipx` from the [installation documentation](../../install.md):
``` ```
sudo apt install pipx sudo apt install pipx
pipx install --pip-args "\--pre" silkaj pipx install --pip-args "\--pre" silkaj
``` ```
To [install and run Silkaj from the container](/contributing/container_usage): To [install and run Silkaj from the container](../../contributing/container_usage.md):
``` ```
sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.11.0rc0 sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.11.0rc0
...@@ -51,7 +51,7 @@ Make sure you test it on Ğ1-Test network to avoid a revocation or any money los ...@@ -51,7 +51,7 @@ Make sure you test it on Ğ1-Test network to avoid a revocation or any money los
## Pipx installation ## Pipx installation
Test that the newly introduced [`pipx` method installation documentation](/install) works fine in your case, with your particular Unix system. Test that the newly introduced [`pipx` method installation documentation](../../install.md) works fine in your case, with your particular Unix system.
Tell us how can the documentation be improved, if a non-obvious step for you is missing or if a necessary package isn't listed for Silkaj to work on your system. Tell us how can the documentation be improved, if a non-obvious step for you is missing or if a necessary package isn't listed for Silkaj to work on your system.
## New CLI design ## New CLI design
......
...@@ -202,14 +202,14 @@ Within 0-342803 range, blocks with a wrong signature: 15144 31202 85448 87566 90 ...@@ -202,14 +202,14 @@ Within 0-342803 range, blocks with a wrong signature: 15144 31202 85448 87566 90
### A. Poetry ### A. Poetry
<center> <center>
![Poetry logo](../../../images/poetry-logo.svg){: style="height:120px;width:120px"} ![Poetry logo](../../images/poetry-logo.svg){: style="height:120px;width:120px"}
</center> </center>
We migrated the packaging and the dependency management tool from Pipenv to Poetry since Pipenv has been quite problematic recently and is also more suitable for larger projects. We migrated the packaging and the dependency management tool from Pipenv to Poetry since Pipenv has been quite problematic recently and is also more suitable for larger projects.
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. 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](/contributing/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.md). You may also interested by checking the newly introduced contribution process documentation `CONTRIBUTING.md`.
### B. Automatic container generation ### B. Automatic container generation
...@@ -223,7 +223,7 @@ Based on the containers set out above, a continuous integration and delivery pip ...@@ -223,7 +223,7 @@ Based on the containers set out above, a continuous integration and delivery pip
- Tests on all supported Python versions, - Tests on all supported Python versions,
- Release publication automation on PyPI and PyPI test. - Release publication automation on PyPI and PyPI test.
![Silkaj pipeline](../../../images/v0.8_pipeline.png) ![Silkaj pipeline](../../images/v0.8_pipeline.png)
## 7. Tests ## 7. Tests
......
...@@ -6,7 +6,7 @@ Part of the Duniter project running the Ğ1 currency, Silkaj project is aiming a ...@@ -6,7 +6,7 @@ Part of the Duniter project running the Ğ1 currency, Silkaj project is aiming a
## Install the development environment ## Install the development environment
We are using [Poetry](https://python-poetry.org/) as a development environment solution. Start by [installing Poetry](/contributing/install_poetry/). We are using [Poetry](https://python-poetry.org/) as a development environment solution. Start by [installing Poetry](./install_poetry.md).
This will install a sandboxed Python environment. 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. Dependencies will be installed in it in order to have Silkaj running and to have pre-installed developement tools.
...@@ -127,7 +127,7 @@ Check out [duniterpy#169](https://git.duniter.org/clients/python/duniterpy/-/iss ...@@ -127,7 +127,7 @@ Check out [duniterpy#169](https://git.duniter.org/clients/python/duniterpy/-/iss
[![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> </center>
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/). We are using [Pytest](https://pytest.org) as a tests framework. For more information on how Silkaj implements them check the [testing documentation](./testing.md).
Tests are stored into `unit` and `integration` folders depending on their types, then using a similar tree as the source code. Tests are stored into `unit` and `integration` folders depending on their types, then using a similar tree as the source code.
......
...@@ -11,7 +11,7 @@ hide: ...@@ -11,7 +11,7 @@ hide:
Welcome to Silkaj documentation Welcome to Silkaj documentation
[Install :material-package-down:](/install){ .md-button .md-button--primary } [Usage :material-keyboard-outline:](/usage){ .md-button .md-button--primary } [Install :material-package-down:](install.md){ .md-button .md-button--primary } [Usage :material-keyboard-outline:](usage/index.md){ .md-button .md-button--primary }
## What is Silkaj? ## What is Silkaj?
......
...@@ -166,4 +166,4 @@ For further details checkout [Click documentation](https://click.palletsprojects ...@@ -166,4 +166,4 @@ For further details checkout [Click documentation](https://click.palletsprojects
## Install to contribute ## Install to contribute
Check out the [installation guide with Poetry](/contributing/install_poetry/). Check out the [installation guide with Poetry](./contributing/install_poetry.md).
...@@ -20,7 +20,7 @@ The file content should be prefixed with `RELATIVE` or `ABSOLUTE` so the amounts ...@@ -20,7 +20,7 @@ The file content should be prefixed with `RELATIVE` or `ABSOLUTE` so the amounts
### Set up the authentication ### Set up the authentication
- Check [authentication documentation](/account_storage#Authentication) on how to handle the authentication. - Check [authentication documentation](./account_storage.md#authentication) on how to handle the authentication.
### Transfer ### Transfer
......
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