Logo
Intro
CI/CD Fundamentals
Introduction to CI/CD Pipelines
Benefits of Using GitLab CI/CD
GitLab CI/CD Components
Practical Implementation of CI/CD Pipelines
.gitlab-ci.yml Basics
How to Create a .gitlab-ci.yml File
Basic Structure of a .gitlab-ci.yml File
Step by Step Guide to Creating a .gitlab-ci.yml File
Advanced Configuration
Full Example
GitLab Runners
GitLab Runners
Choosing the Right Runners
Runner Configuration
Runner Management Best Practices
Why Use Runners?
GitLab Executors
What Are GitLab Executors?
Why Are Executors Important?
Docker Executor
Shell Executor
Specific Runners
Installing Specific Runners
Installing GitLab Runner on Linux
Installing GitLab Runner on macOS
Installing GitLab Runner on Windows
Creating the Runner
Registering the Runner
Verifying the Runner
Configuring the Runner
Artifacts
Artifacts in GitLab CI/CD
Storing Artifacts in .gitlab-ci.yml
Retrieving Artifacts
Using Artifacts in Subsequent Jobs
Advanced Artifact Management
Conclusions
Documentation Generation
Documentation Generation in GitLab CI/CD Pipelines
Setting Up MkDocs
Configuring MkDocs
Creating Documentation Pages
Summary
Monitoring
Basic Monitoring in GitLab CI/CD
Enable Pipeline Monitoring
Add Notifications for Pipeline Events
Add Notifications for Pipeline Events

Documentation Generation

Configuring MkDocs

< >

3. Writing Documentation

Writing documentation in Markdown is straightforward. This section will cover how to effectively use Markdown to create well-structured documentation.

Practical Exercise

  1. Write Documentation in Markdown:

    • Edit the index.md file to include project details and instructions. For example: 
      # Welcome to My Project

This is the documentation for my project. Here you will find instructions on how to use and contribute to the project.

  2. Explore Markdown Syntax:

    • Familiarize yourself with Markdown syntax by adding headings, lists, links, and images to your index.md and about.md files.

  3. Preview Your Documentation:

    • Use the mkdocs serve command again to preview your updated documentation in the browser.