Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update contributing in readme #409

Merged
merged 2 commits into from
Mar 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ If you need support, please either raise an issue on Github or ask on [Slack](ht

If you would like to contribute to this documentation please clone it locally and make a new branch with the suggested changes.

You should use python `3.8`.
You should use python `3.10`.

To deploy the documentation locally you will need to install all the necessary requirements which you can find in the 'requirements.txt' file of the root of this repository. You can use pip in your terminal to install it: `pip install -r requirements.txt`.
To deploy the documentation locally you need to install all the necessary requirements which you can find in the 'requirements.txt' file of the root of this repository. You can use pip in your terminal to install it: `pip install -r requirements.txt`.

You also need to manually install [pandoc](https://github.com/jgm/pandoc/releases/tag/3.1.11.1).


### Install substra, substratools and substrafl in editable mode
Expand Down
2 changes: 2 additions & 0 deletions docs/source/additional/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Substra 0.36.0 --- 2024-03-12

- Python 3.8 is not supported anymore. We support Python versions 3.9, 3.10 and 3.11.
- Status renaming:

- Compute task status `DOING` is renamed `EXECUTING`;
- Compute plan statuses `EMPTY`, `WAITING` and `TODO` are merged into new status `CREATED`;
- See `the documentation <https://docs.substra.org/en/stable/documentation/concepts.html#compute-plan>`__ for more details on statuses.
Expand Down Expand Up @@ -190,6 +191,7 @@ Substra 0.30.0 --- 2023-07-27
- User validation approval: this new feature (disabled by default) enable Substra admins to validate or reject new users that login with the SSO. Before the validation new user can not do nor see anything on Substra. To setup this feature have a look at `the SSO documentation <https://docs.substra.org/en/stable/operations/howto/sso-oidc.html#set-up-user-creation>`__.

**Documentation**:

- `New example <https://docs.substra.org/en/stable/examples/substrafl/go_further/run_diabetes_substrafl.html>`__ on Federated Analytics with SubstraFL
- `New example <https://docs.substra.org/en/stable/examples/substrafl/go_further/run_mnist_cyclic.html>`__ on how to implement a custom cyclic Strategy with SubstraFL.

Expand Down
Loading