1 Prerequisites This skill 0 Unlocked

Skill · Documentation · Document a service or a project

Build and publish documentation checked in CI

Have documentation checked by a pipeline (markdownlint, Vale, links, strict build) and publish it as a static site, then fix what the pipeline reports.

Start lesson 1The Documentation domain

• 3 lessons
• ~1 h 25 of reading
• 7 quizzes
• 0 proof lab

The path

Where it comes from, where it leads

What you need to know first, where you stand on this skill, and what it opens next. Your status is computed in your browser, from what you have read and passed.

Before · 1 prerequisite

• Write a clear, accessible and verifiable technical page

Depending on the chosen tool, you also need:

• Astro Starlight (default)

  nothing more

• MkDocs

  nothing more

• Docusaurus

  nothing more

• Hugo

  nothing more

• Antora

  • Write a technical document in AsciiDoc: structure, attributes, blocks and conversion

Recommended before · 4

• Keep documentation alive: owner, review, freshness
• Collaborate on a remote repository and resolve a conflict
• Write a first pipeline and read its failures
• Write and review a correct, unambiguous YAML document

This skill, for you

Build and publish documentation checked in CI

Computing

It unlocks · nothing yet

No other skill requires it: it is an end-of-path skill.

Lessons

How to learn it

This skill is learned with the tool of your choice; your preferences decide the path followed in your journey. Each path lists its lessons in program order.

With Astro Starlight

3 lessons · ~1 h 25 default

1. 1Choisir ses outils de documentation (in French)· 25 min
2. 2Créer un site de documentation avec Astro Starlight (in French)· 35 min
3. 3Créer une collection de postmortems SRE avec Astro Starlight (in French)· 25 min

With MkDocs

2 lessons · ~1 h 00

1. 1Choisir ses outils de documentation (in French)· 25 min
2. 2MkDocs : créer un site de documentation DevOps (in French)· 35 min

With Docusaurus

2 lessons · ~45 min

1. 1Choisir ses outils de documentation (in French)· 25 min
2. 2Docusaurus : créer un site de documentation moderne (in French)· 20 min

With Hugo

2 lessons · ~55 min

1. 1Choisir ses outils de documentation (in French)· 25 min
2. 2Hugo : créer un site de documentation DevOps (in French)· 30 min

With Antora

2 lessons · ~1 h 00

1. 1Choisir ses outils de documentation (in French)· 25 min
2. 2Antora : créez vos sites docs statiques (in French)· 35 min

Beyond the lessons

Assess, practise, pass the proof

Reading a lesson confirms nothing. A skill is confirmed by a passed quiz, practised in a guided lab, and put to the test by a challenge or a mission; an imported lab result is not verified by the site.

Assess yourself

7 quizzes

At the end of the lessons: passed at 70%, they confirm the skill.

Practice

No guided lab

No guided lab practices it yet.

Proof

No proof

Neither a challenge nor a mission with a proof yet.

Around it

Who requires it, who teaches it

Required by

• CI/CD Engineer
• Platform Engineer

Taught by

• Documenter (in French)

Tool of your choice: Astro Starlight or MkDocs or Docusaurus or Hugo or Antora.

Same block · Document a service or a project

• Choose the document type and its reader before writing
• Write a clear, accessible and verifiable technical page
• Give a repository its README, CHANGELOG and ADRs
• Represent a system with diagrams as code that read without the image
• Keep documentation alive: owner, review, freshness
• Document code: comments that say why, docstrings, generated reference
• Model an architecture beyond context: components, dynamic and deployment views, a single model in code
• Write a technical document in AsciiDoc: structure, attributes, blocks and conversion
• Build a technical presentation in Markdown or HTML, versioned and exported

×

See in the glossary →