diff --git a/docs/blog/posts/v0.10.0.md b/docs/blog/posts/v0.10.0.md index 4dbcd72feb7b65186e489b8ef63c5d25c2d377d5..23465949036c90034933799c0f71070ce7fe3d75 100644 --- a/docs/blog/posts/v0.10.0.md +++ b/docs/blog/posts/v0.10.0.md @@ -11,7 +11,7 @@ categories: Silkaj team is pleased to announce the stable release of Silkaj version 0.10.0 -The most important changes are highlighted in this article, if you are looking for a comprehensive list of changes, check out the [changelog](CHANGELOG.md). +The most important changes are highlighted in this article, if you are looking for a comprehensive list of changes, check out the changelog. ## Introduction @@ -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](doc/docker.md). +You can find the [documentation on how to use these images](/docker). ## Network diff --git a/docs/blog/posts/v0.10.0rc.md b/docs/blog/posts/v0.10.0rc.md index cae3b0bdc074b21873ca864cedbbec5e302815cb..4523c68648145d4e8a216e1543f6f8cd69565986 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 the Docker image](doc/docker.md): +To [install and run Silkaj from the Docker image](/docker): ```bash sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.10.0rc0 diff --git a/docs/blog/posts/v0.11.0.md b/docs/blog/posts/v0.11.0.md index b7d597f8f9f15d3f47c964e49e09a0103fac8bd2..0415f2f335f0386d6a86cb19b6418af77f8e3517 100644 --- a/docs/blog/posts/v0.11.0.md +++ b/docs/blog/posts/v0.11.0.md @@ -11,7 +11,7 @@ categories: Silkaj team is pleased to announce the stable release of Silkaj version 0.11.0 -The most important changes are highlighted in this article, if you are looking for a comprehensive list of changes, check out the [changelog](CHANGELOG.md). +The most important changes are highlighted in this article, if you are looking for a comprehensive list of changes, check out the changelog. ## Introduction @@ -43,7 +43,7 @@ sudo apt install pipx libsodium23 pipx install silkaj ``` -For a comprehensive documentation, check [how to install with pipx](doc/install_pipx.md). +For a comprehensive documentation, check [how to install with pipx](/install_pipx). ## New CLI design diff --git a/docs/blog/posts/v0.11.0rc0.md b/docs/blog/posts/v0.11.0rc0.md index e0be619934dc44e2c229f933ee97b95be0440561..baa38d5b9603e495c6a5afc09ba935a4e87a6b1e 100644 --- a/docs/blog/posts/v0.11.0rc0.md +++ b/docs/blog/posts/v0.11.0rc0.md @@ -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. To install the Python package, run following command: -Install `pipx` from the [pipx installation documentation](doc/install_pipx.md): +Install `pipx` from the [pipx installation documentation](/install_pipx): ```bash sudo apt install pipx pipx install --pip-args "\--pre" silkaj ``` -To [install and run Silkaj from the Docker image](doc/docker.md): +To [install and run Silkaj from the Docker image](/docker): ```bash sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.11.0rc0 @@ -43,7 +43,7 @@ sudo docker run -it registry.duniter.org/clients/python/silkaj/release/pip:v0.11 ## Tests -Please check [v0.11.0 milestone short summary](https://git.duniter.org/clients/python/silkaj/-/milestones/15) as well as the [changelog](CHANGELOG.md) containing the changes which did happen during this development cycle. +Please check [v0.11.0 milestone short summary](https://git.duniter.org/clients/python/silkaj/-/milestones/15) as well as the changelog containing the changes which did happen during this development cycle. Structural changes were made, so please check Silkaj is still working in its entirety. Manual tests help us making sure everything works fine in different cases. @@ -51,7 +51,7 @@ Make sure you test it on Ğ1-Test network to avoid a revocation or any money los ## Pipx installation -Test that the newly introduced [`pipx` method installation documentation](doc/install_pipx.md) works fine in your case, with your particular Unix system. +Test that the newly introduced [`pipx` method installation documentation](/install_pipx) 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. ## New CLI design diff --git a/docs/blog/posts/v0.8.md b/docs/blog/posts/v0.8.md index d71503991512f17c08e744bc551831772d263807..85ce0f32f598bcc8e1722d25875099dc831dbbf8 100644 --- a/docs/blog/posts/v0.8.md +++ b/docs/blog/posts/v0.8.md @@ -13,7 +13,7 @@ categories: The Silkaj team is pleased to announce the release of Silkaj 0.8.0. A new team member joined us at the beginning of this development cycle: Matograine. We highly appreciate his commitment, his improvements of the transaction code and his work on the checksum. This release comes along with a number of new features and improvements. -The most important of them are highlighted in this article, if you are looking for a comprehensive list of changes, check out the [changelog](https://git.duniter.org/clients/python/silkaj/blob/main/CHANGELOG.md). +The most important of them are highlighted in this article, if you are looking for a comprehensive list of changes, check out the changelog. <!-- more --> @@ -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](https://git.duniter.org/clients/python/silkaj/-/blob/main/doc/install_poetry.md). You may also interested by checking the newly introduced [contribution process documentation `CONTRIBUTING.md`](https://git.duniter.org/clients/python/silkaj/-/blob/main/CONTRIBUTING.md). +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`. ### B. Automatic container generation diff --git a/docs/blog/posts/v0.9.0rc.md b/docs/blog/posts/v0.9.0rc.md index 5aa431e0c953c10d8e0b1753932dad6b4fe707f1..394e2129cb3768b96132f24c87f2e5d0eead67a5 100644 --- a/docs/blog/posts/v0.9.0rc.md +++ b/docs/blog/posts/v0.9.0rc.md @@ -21,7 +21,7 @@ To install this pre-release version from PyPI, use this command: pip3 install silkaj --user --upgrade --pre ``` -Please test it globally, and check [the changelog](https://git.duniter.org/clients/python/silkaj/-/blob/main/CHANGELOG.md#v090rc-24th-march-2021) which contains the changes which happen during this development cycle. +Please test it globally, and check the changelog which contains the changes which happen during this development cycle. Pay a special attention to the transaction part where a part of the algorithm changed. There are new options on following commands: diff --git a/docs/blog/posts/v0.9.md b/docs/blog/posts/v0.9.md index ec1b76c4a8d0a646b4028ed58039942d93c40328..78bc48490e866391483eb3cd0dbcb6ce894602cd 100644 --- a/docs/blog/posts/v0.9.md +++ b/docs/blog/posts/v0.9.md @@ -12,7 +12,7 @@ categories: ## Introduction The Silkaj team is pleased to announce the release of Silkaj 0.9.0. -The most important changes are highlighted in this article, if you are looking for a comprehensive list of changes, check out the [changelog](https://git.duniter.org/clients/python/silkaj/blob/main/CHANGELOG.md). +The most important changes are highlighted in this article, if you are looking for a comprehensive list of changes, check out the changelog. <!-- more -->