Dokumentation über GitLab Pages bereitstellen

Dokumentationserstellung

4. Dokumentation über GitLab Pages bereitstellen

Sobald Ihre Dokumentation fertig ist, können Sie GitLab CI/CD so einrichten, dass sie automatisch gebaut und über GitLab Pages bereitgestellt wird.

Praktische Übung

1. Datei .gitlab-ci.yml erstellen:

   • Erstellen Sie im Stammverzeichnis Ihres Projekts eine Datei .gitlab-ci.yml mit folgendem Inhalt:

     image: python:3.8
     
     pages:
       stage: deploy
       script:
         - pip install mkdocs
         - mkdocs build -d public
       artifacts:
         paths:
           - public
     

2. Änderungen nach GitLab übertragen:

   • Committen Sie Ihre Änderungen und übertragen Sie sie in Ihr GitLab-Repository:

     git add .
     git commit -m "Set up MkDocs and GitLab CI/CD"
     git push origin main
     

3. GitLab Pages aufrufen:

   • Nachdem die Pipeline erfolgreich durchgelaufen ist, öffnen Sie in Ihrem GitLab-Repository Settings > Pages, um die URL Ihrer bereitgestellten Dokumentation zu finden.