Commit 379c2ccd authored by coconux's avatar coconux
Browse files

Add open in a new tab when click on externel link.Fix some links

parent 0f49a410

README.md

+1 −1
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ Check the [documentation](https://r2devops.io) 📚 
### Requirements



Documentation is built using [Mkdocs](https://www.mkdocs.org) and [Material for

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

Mkdocs](https://squidfunk.github.io/mkdocs-material/){:target="_blank"}.



Make sure that `python` and `pip` are installed on your system. Then install

all required components:

docs/use-the-hub.md

+1 −1
Original line number Diff line number Diff line
@@ -139,4 +139,4 @@ trivy_image: 
!!! tip

    In this way, you can override all Gitlab jobs parameters. All parameters

    are described in [Gitlab

    documentation](https://docs.gitlab.com/ee/ci/yaml/).
 
    documentation](https://docs.gitlab.com/ee/ci/yaml/){:target="_blank"}.

docs/versioning.md

+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
Each job of the hub are versioned using a git tag.



!!! note

    Version follows the [Semantic Versioning](https://semver.org/).

    Version follows the [Semantic Versioning](https://semver.org/){:target="_blank"}.



You can also use the latest version using `latest` instead of a tag. Using

this, you will retrieve the latest version of jobs at each run. Note that if

jobs/apidoc/README.md

+6 −6
Original line number Diff line number Diff line
@@ -3,13 +3,13 @@ 
## Description



Creates a versioned HTML documentation from API annotations in your source

code using [apiDoc](https://www.apidocjs.com/).

code using [apiDoc](https://www.apidocjs.com/){:target="_blank"}.



## How to use it



1. Prepare your project with API annotations in your source code following

   [apiDoc format](https://apidocjs.com/#examples) and your [apiDoc

   configuration file](https://apidocjs.com/#configuration).

   [apiDoc format](https://apidocjs.com/#examples){:target="_blank"} and your [apiDoc

   configuration file](https://apidocjs.com/#configuration){:target="_blank"}.

2. Choose a version in [version list](#changelog)

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

   started](/use-the-hub/)). Example:
@@ -27,7 +27,7 @@ code using [apiDoc](https://www.apidocjs.com/). 


* Job name: `apidoc`

* Docker image:

[`node`](https://hub.docker.com/r/_/node)

[`node`](https://hub.docker.com/r/_/node){:target="_blank"}

* Default stage: `build`

* When: `always`
@@ -43,11 +43,11 @@ code using [apiDoc](https://www.apidocjs.com/). 
### Artifacts



Result of documentation build is [exposed

as](https://docs.gitlab.com/ee/ci/yaml/#artifactsexpose_as) `apiDoc build` in

as](https://docs.gitlab.com/ee/ci/yaml/#artifactsexpose_as){:target="_blank"} `apiDoc build` in

merge requests.



!!! warning

    Exposition of artifact doesn't work currently because of [this issue from

    Gitlab](https://gitlab.com/gitlab-org/gitlab/-/issues/37129). As soon as

    Gitlab](https://gitlab.com/gitlab-org/gitlab/-/issues/37129){:target="_blank"}. As soon as

    the issue will be fixed, exposed artifacts will be available in merge

    requests.

jobs/docker_build/README.md

+5 −6
Original line number Diff line number Diff line
@@ -2,10 +2,10 @@ 


## Description



Build a [docker](https://www.docker.com/) image of your application

Build a [docker](https://www.docker.com/){:target="_blank"} image of your application

from a Dockerfile at the root of your project, and push it to a

remote registry. The build part is done using

[kaniko](https://github.com/GoogleContainerTools/kaniko).

[kaniko](https://github.com/GoogleContainerTools/kaniko){:target="_blank"}.



!!! info

    By default, your images will be pushed to the Gitlab Container
@@ -14,7 +14,7 @@ remote registry. The build part is done using 
## How to use it



1. Create a

   [Dockerfile](https://docs.docker.com/get-started/part2/#sample-dockerfile) (by default at the root of your project)

   [Dockerfile](https://docs.docker.com/get-started/part2/#sample-dockerfile){:target="_blank"} (by default at the root of your project)

   to containerize your application

2. Choose a version in [version list](#changelog)

3. Add the corresponding URL to your `.gitlab-ci.yml` file (see [Getting
@@ -30,14 +30,13 @@ remote registry. The build part is done using 
## Job details



* Job name: `docker_build`

* Docker image: [`gcr.io/kaniko-project/executor:debug-v0.20.0`](https://github.com/GoogleContainerTools/kaniko)

* Docker image: [`gcr.io/kaniko-project/executor:debug-v0.20.0`](https://github.com/GoogleContainerTools/kaniko){:target="_blank"}

* Default stage: `build`



### Build behavior



!!! info

    This build will use Gitlab CI predefined [environment variables]

    (https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)

    This build will use Gitlab CI predefined [environment variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html){:target="_blank"}

    to know you are in a `commit` context or a `tag` context

    (for example if you are releasing a new version of your project).