Commit 4df7d4f3 authored by Kostis Trantzas's avatar Kostis Trantzas
Browse files

fix for #9: 

- added documentation version as variable in mkdocs.yml (extra.documentation_version)
parent 47c7c175

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@ pages: 
    PAGES_BRANCH: gl-pages

    HTTPS_REMOTE: https://gitlab-ci-token:${ACCESS_TOKEN}@${CI_SERVER_HOST}/rep/${CI_PROJECT_PATH}.git

  before_script:

    - pip install -q mkdocs-material mike mkdocs-glightbox

    - pip install -q mkdocs-material mkdocs-glightbox mkdocs-markdownextradata-plugin mike 

    - apt-get update -qq && apt-get -qq install -y git > /dev/null

    - git config --global --replace-all user.name $GITLAB_USER_NAME

    - git config --global --replace-all user.email $GITLAB_USER_EMAIL

doc/contributing/documenting.md

+4 −2
Original line number Diff line number Diff line
@@ -45,8 +45,9 @@ git checkout develop 
    ``` bash

    python -m pip install mkdocs

    python -m pip install mkdocs-material

    python -m pip install mike

    python -m pip install mkdocs-glightbox

    python -m pip install mkdocs-markdownextradata-plugin

    python -m pip install mike

    ```



=== "Windows"
@@ -58,8 +59,9 @@ git checkout develop 
    ``` bash

    python -m pip install mkdocs

    python -m pip install mkdocs-material

    python -m pip install mike

    python -m pip install mkdocs-glightbox

    python -m pip install mkdocs-markdownextradata-plugin

    python -m pip install mike

    ```

doc/getting_started/deployment/docker_compose.md

+4 −4
Original line number Diff line number Diff line
@@ -66,7 +66,7 @@ cd openslice 
Download the deployment / environment preparation script



```bash

wget https://labs.etsi.org/rep/osl/code/org.etsi.osl.main/-/raw/develop/compose/deploy.sh

wget https://labs.etsi.org/rep/osl/code/org.etsi.osl.main/-/raw/{{{ documentation_version }}}/compose/deploy.sh

```



Make it executable
@@ -86,10 +86,10 @@ If you run the script without selecting a branch the the main branch is going to 
We recommend:



* main branch for the most stable experience and

* develop branch for an experience with the latest features (for develop branch installation, it is strongly advisable that you may as well follow the [develop documentation](https://osl.etsi.org/documentation/develop/deployment/))

* develop branch for an experience with the latest features (for develop branch installation, it is strongly advisable that you may as well follow the [develop documentation](https://osl.etsi.org/documentation/develop/))



```bash

sudo ./deploy.sh develop #[or replace main with other branch name]

sudo ./deploy.sh main #[or replace main with other branch name]

```



> **We recommend running the deploy.sh script with root permissions! In other case, some directories may not be accessible by the project building tools and hinder the smooth installation.**
@@ -333,7 +333,7 @@ Example file: 
```json

{	      

    "TITLE": "OpenSlice by ETSI",

    "PORTALVERSION":"2024Q2",

    "PORTALVERSION":"{{{ documentation_version }}}",

    "WIKI": "https://osl.etsi.org/documentation",

    "BUGZILLA": "{BASEURL}/bugzilla/",

    "STATUS": "{BASEURL}/status/",

doc/getting_started/deployment/kubernetes.md

+3 −3
Original line number Diff line number Diff line
@@ -84,12 +84,12 @@ cd org.etsi.osl.main/kubernetes/helm/openslice/ 


### 3. Prerequisites before deployment



Before deploying the Helm chart, ensure you have configured the necessary components as detailed in the following section, i.e. [Configure Helm Chart Services](#configure-helm-chart). By default, the `main` branch is selected for deployment.

Before deploying the Helm chart, ensure you have configured the necessary components as detailed in the following section, i.e. [Configure Helm Chart Services](#configure-helm-chart).



We recommend:



* main branch for the most stable experience and

* develop branch for an experience with the latest features (for develop branch installation, it is strongly advisable that you may as well follow the [develop documentation](https://osl.etsi.org/documentation/develop/deployment/))

* develop branch for an experience with the latest features (for develop branch installation, it is strongly advisable that you may as well follow the [develop documentation](https://osl.etsi.org/documentation/develop/))





## Configure Helm Chart
@@ -346,7 +346,7 @@ E.g. You may edit "TITLE", "WIKI", etc properties with your domain title. Also c 
```json

{	      

    "TITLE": "OpenSlice by ETSI",

    "PORTALVERSION":"2024Q2",

    "PORTALVERSION":"{{{ documentation_version }}}",

    "WIKI": "https://osl.etsi.org/documentation",

    "BUGZILLA": "{BASEURL}/bugzilla/",

    "STATUS": "{BASEURL}/status/",

doc/index.md

+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 


<img src="images/openslice_logo.png" alt="logo" width="200"/>



**Version**: 2024Q2 - SNAPSHOT ([Release Notes](https://labs.etsi.org/rep/osl/code/org.etsi.osl.main/-/releases/2024Q2))

**Version**: {{{ documentation_version }}} ([Release Notes](https://labs.etsi.org/rep/osl/code/org.etsi.osl.main/-/releases/{{{ documentation_version }}}))



The ETSI Software Development Group for OpenSlice (SDG OSL) is developing an open-source service-based Operations Support System (OSS) to deliver Network as a Service (NaaS) following specifications from major SDOs including ETSI, TM Forum and GSMA.