Commit 45b10439 authored by Kostis Trantzas's avatar Kostis Trantzas
Browse files

fix for #9

- Updating contributing/documenting.md file
parent 2fc02f6b
Loading
Loading
Loading
Loading
Loading
+29 −12
Original line number Diff line number Diff line
@@ -3,8 +3,6 @@

OpenSlice's documentation runs on [MkDocs](https://www.mkdocs.org/).

> This page is a WIP. Updates are ongoing.

## Eligibility

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:

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 desired branch (don't forget to select one or make one!):
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
    git checkout develop #[or another branch]
python3 -m venv venv
source venv/bin/activate
 python -m pip install mkdocs
 python -m pip install mkdocs-material
 python -m pip install mike
```

3. Document (and commit)! 😊
4) Wait for all downloads to finish and start the mkdocs server
```bash
mkdocs serve
```

5) Document (and commit)! 😊

Before committing, you should make sure that the local mkdcocs server's terminal is not producing any INFO/WARNING message regarding your contributions.


> 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.