Commit 683de7c7 authored by Thomas Boni's avatar Thomas Boni
Browse files

split the documentation of mkdocs and pages

parent 5e3fc898

Jobs/mkdocs/mkdocs.yml

+3 −3
Original line number Diff line number Diff line
@@ -12,6 +12,6 @@ documentation: 
    expose_as: "Documentation"

    paths:

      - public/

  except:

    variables:

      - $DOCUMENTATION_DISABLE
 
  rules:

    - if: '$DOCUMENTATION_DISABLE'

      when: never

Jobs/pages/pages.yml

+5 −6
Original line number Diff line number Diff line 
# Job from g2s hub. See https://go2scale.gitlab.io/hub/ for more informations



pages:

  stage: production

  stage: deployment

  script:

    - echo 'Deploying on Gitlab pages'

  needs:
@@ -10,8 +10,7 @@ pages: 
  artifacts:

    paths:

      - public

  only:

    - master

  except:

    variables:

      - $DOCUMENTATION_DISABLE || $PAGES_DISABLE
 
  rules:

    - if: '$DOCUMENTATION_DISABLE || $PAGES_DISABLE'

      when: never

    - if: '$CI_COMMIT_BRANCH == "master"'

docs/Jobs/mkdocs/README.md

+16 −33
Original line number Diff line number Diff line 
# 📗 Mkdocs

# 📦 Mkdocs



## Description



Build HTML documentation form Markdown source using

[Mkdocs](https://www.mkdocs.org/) and deploy it on Gitlab pages. All

requirements to use [Material for

Mkdocs](https://squidfunk.github.io/mkdocs-material/) are installed.

[Mkdocs](https://www.mkdocs.org/). All requirements to use [Material for

Mkdocs](https://squidfunk.github.io/mkdocs-material/) are ready to use.



## How to use it
@@ -17,7 +16,7 @@ Mkdocs](https://squidfunk.github.io/mkdocs-material/) are installed. 


    ```yaml

    include:

      - remote: 'https://gitlab.com/go2scale/jobs/-/raw/2020-06-22_1/Jobs/mkdocs/mkdocs.yml'

      - remote: 'https://gitlab.com/go2scale/hub/-/raw/latest/Jobs/mkdocs/mkdocs.yml'

    ```



4. If you need set variables in jobs, use `variables` option in
@@ -42,39 +41,23 @@ Build HTML documentation from Makdown source using `Mkdocs`. 
| `DOCUMENTATION_DISABLE` | Disable build | |





### Pages



* Docker image: [ruby](https://hub.docker.com/_/ruby)

* When: only run on `master` branch

* Stage: production

* Artifacts:

    * Result of documentation from previous job. It's used as input for Gitlab

      pages

* Variables:



| Name | Description | Default |

| ---- | ----------- | ------- |

| `DOCUMENTATION_DISABLE` | Disable publication on Gitlab pages| |

| `PAGES_DISABLE` | Disable publication on Gitlab pages | |



## Versions



### Latest

* **Latest** : `https://gitlab.com/go2scale/jobs/-/raw/master/Jobs/mkdocs/mkdocs.yml`

* **Tag `2020-07-13_1`** : `https://gitlab.com/go2scale/hub/-/raw/2020-07-31_1/Jobs/mkdocs/mkdocs.yml`



```

https://gitlab.com/go2scale/jobs/-/raw/master/Jobs/mkdocs/mkdocs.yml

```

    !!! warning

        Since this version, `pages` job, which publish documentation on Gitlab

        pages, isn't included anymore. It's now a dedicated job:

        [pages](Jobs/pages).



### Tag `2020-05-31_1`

* **Tag `2020-05-31_1`** : `https://gitlab.com/go2scale/hub/-/raw/2020-05-31_1/Jobs/mkdocs/mkdocs.yml`



    !!! warning

        This update introduces breaking changes. Follow [this

        guide](https://squidfunk.github.io/mkdocs-material/releases/5/#how-to-upgrade)

        to know how to upgrade.

    * Upgrade Material for Mkdocs to v5



```

https://gitlab.com/go2scale/jobs/-/raw/2020-05-31_1/Jobs/mkdocs/mkdocs.yml

```



* Upgrade Material for Mkdocs to v5

docs/Jobs/pages/.pages

0 → 100644
+1 −0
Original line number Diff line number Diff line 
collapse: true

docs/Jobs/pages/README.md

0 → 100644
+52 −0
Original line number Diff line number Diff line 
# 🚀 Pages



## Description



Publish HTML documentation located in `public` folder, retrieved as an artifact

from previous job named `documentation`.



## How to use it



!!! note "Requirements"

    * Use a `documentation` job in build 📦 stage to be able to retrieve the

      documentation to publish as artifact. Example: [Mkdocs](/Jobs/mkdocs/)



1. Choose a version in [version list](#versions)

2. Add the corresponding url to your `.gitlab-ci.yml` file (see [Getting

   started](/getting-started)). Example:



    ```yaml

    include:

      - remote: 'https://gitlab.com/go2scale/hub/-/raw/latest/Jobs/pages/pages.yml'

    ```



3. If you need set variables in jobs, use `variables` option in

   `.gitlab-ci.yml` file



## Jobs



### Pages



* Docker image: [ruby](https://hub.docker.com/_/ruby)

* When: only run on `master` branch

* Stage: deployment

* Artifacts:

    * Result of documentation from previous job. It's used as input for Gitlab

      pages

* Variables:



| Name | Description | Default |

| ---- | ----------- | ------- |

| `DOCUMENTATION_DISABLE` | Disable publication on Gitlab pages| |

| `PAGES_DISABLE` | Disable publication on Gitlab pages | |



## Versions



* **Latest** : `https://gitlab.com/go2scale/jobs/-/raw/master/Jobs/mkdocs/mkdocs.yml`

* **Tag `2020-05-31_1`** : `https://gitlab.com/go2scale/jobs/-/raw/2020-05-31_1/Jobs/mkdocs/mkdocs.yml`



    !!! warning

        This update introduces breaking changes. Follow [this

        guide](https://squidfunk.github.io/mkdocs-material/releases/5/#how-to-upgrade)

        to know how to upgrade.

    * Initial version