Skip to content
Snippets Groups Projects
Commit 45b10439 authored by trantzas's avatar trantzas
Browse files

fix for #9

- Updating contributing/documenting.md file
parent 2fc02f6b
No related branches found
No related tags found
1 merge request!14Resolve "Creating Release 2024Q4 documentation"
Pipeline #10905 passed
...@@ -3,8 +3,6 @@ ...@@ -3,8 +3,6 @@
OpenSlice's documentation runs on [MkDocs](https://www.mkdocs.org/). OpenSlice's documentation runs on [MkDocs](https://www.mkdocs.org/).
> This page is a WIP. Updates are ongoing.
## Eligibility ## Eligibility
Documenting OpenSlice is limited to active contributors. So, if you: Documenting OpenSlice is limited to active contributors. So, if you:
...@@ -23,18 +21,37 @@ Documenting OpenSlice is limited to active contributors. So, if you: ...@@ -23,18 +21,37 @@ Documenting OpenSlice is limited to active contributors. So, if you:
To contribute to OpenSlice's documentation, you need to follow those easy steps: To contribute to OpenSlice's documentation, you need to follow those easy steps:
1. Clone the [repository](https://labs.etsi.org/rep/osl/documentation) with: 1) Clone the [Documentation repository](https://labs.etsi.org/rep/osl/documentation) with:
```bash
git clone https://labs.etsi.org/rep/osl/documentation.git
```
2) Checkout the develop branch (incoming contributions are only accepted to the develop branch):
```bash
cd ./documentation
git checkout develop
```
3) Setup a local mkdocs server, using a virtual environment
```bash
python3 -m venv venv
source venv/bin/activate
python -m pip install mkdocs
python -m pip install mkdocs-material
python -m pip install mike
```
```bash 4) Wait for all downloads to finish and start the mkdocs server
git clone https://labs.etsi.org/rep/osl/documentation.git ```bash
``` mkdocs serve
```
2. Checkout the desired branch (don't forget to select one or make one!): 5) Document (and commit)! 😊
```bash Before committing, you should make sure that the local mkdcocs server's terminal is not producing any INFO/WARNING message regarding your contributions.
git checkout develop #[or another branch]
```
3. Document (and commit)! 😊
> The documentation website supports branches, so your changes will be reflected in the corresponding branch. > The documentation website supports branches, so your accepted changes will be reflected to the develop branch which becomes the Release branch after each corresponding cycle.
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