Commit 20a51b99 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

doc(links): repair broken links

parent 5e44a884

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -52,7 +52,7 @@ check-links: 
    entrypoint: [""]

  stage: build

  script:

    - lychee *.md docs/ static/

    - lychee --exclude http://127.0.0.1 --exclude https://my-nonprod-k8s.domain *.md docs/ static/

  allow_failure: true



# publish on GitLab pages: only on master

README.md

+1 −1
Original line number Diff line number Diff line 
# To Be Continuous website



This project build and exposes _to be continuous_ website as [GitLab pages](to-be-continuous.gitlab.io/doc).

This project build and exposes _to be continuous_ website as [GitLab pages](https://to-be-continuous.gitlab.io/doc/).



The documentation is built with [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).

docs/dev/guidelines.md

+1 −1
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ As a template developer, you should make everything possible to honor [the guidi 
    1. the least stages, the best

    1. parallelize all jobs that can be

    1. long jobs (5 min or more) should not be auto-run by default, but rather [manually](https://docs.gitlab.com/ee/ci/yaml/#whenmanual)

       or [scheduled](https://docs.gitlab.com/ee/user/project/pipelines/schedules.html). <br/>

       or [scheduled](https://docs.gitlab.com/ee/ci/pipelines/schedules.html). <br/>

       Projects willing to auto-run those jobs should be able to override the default.



## Stages

docs/faq.md

+2 −2
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ More info available on [choosealicense.com](https://choosealicense.com/licenses/ 


This has been an internal project at [Orange](https://orange.com) for 2 years before becoming an Open Source project.



The project is still mainly developed and maintained by Orange developers, but anyone is welcome to [contribute](../dev/workflow/).

The project is still mainly developed and maintained by Orange developers, but anyone is welcome to [contribute](dev/workflow.md).



## Can I use _to be continuous_ on my self-managed GitLab?
@@ -24,4 +24,4 @@ The project is still mainly developed and maintained by Orange developers, but a 


Yes.



We have an extensive documentation about [how to use _to be continuous_ in your own self-managed GitLab](../self-managed/basic/).
 
We have an extensive documentation about [how to use _to be continuous_ in your own self-managed GitLab](self-managed/basic.md).

docs/self-managed/basic.md

+2 −2
Original line number Diff line number Diff line
@@ -41,7 +41,7 @@ As a result you won't be able to run any pipeline as long as don't have any trac 
Go in your local copy of the [tools/tracking](https://gitlab.com/to-be-continuous/tools/tracking) project, and manually click

the last `docker-publish` job that should be pending (if it's not the case, manually start a fresh new pipeline, then click the `docker-publish` job when it's pending). It may happen that the publish job fails the first time: simply retry it.



We'll see later [how to configure the tracking project](../advanced/#setup-tracking) to collect statistics about template jobs execution.

We'll see later [how to configure the tracking project](advanced.md#setup-tracking) to collect statistics about template jobs execution.

For now it is unconfigured, and will not track anything.



## Sync. your local copy of tbc
@@ -64,7 +64,7 @@ All other required variables shall be retrieved from [GitLab CI predefined varia 
    If you need to modify template code, you'll have 2 options depending on your case:



    * if it's a general enhancement/fix: make a contribution to the Open Source [to be continuous project](https://gitlab.com/to-be-continuous/) and get the change through the synchronization task,

    * if it's a change specific to your company: see [advanced usage](../advanced.md)

    * if it's a change specific to your company: see [advanced usage](advanced.md)



By the way, you can manually trigger a pipeline in your [tools/gitlab-sync](https://gitlab.com/to-be-continuous/tools/gitlab-sync) project

anytime to synchronize your _to be continuous_ copy.