Skip to content

Set up a CI/CD workflow to deploy the user manual book #1

@jevgarrido

Description

@jevgarrido

Summary

Host the user's manual mdbook online for easy access and have the deployment process automated.


Usage

  • Have a link to the mdbook in the front page of the repository that takes you to the user manual.

To Do

  • Get somewhere to host the book.

    Look into Github Pages

  • Configure the CI/CD pipeline for the mdbook.

    Attention: Book is rooted in a subdirectory.

    Look into actions-mdbook

    Look into actions-gh-pages

  • Provide a link to 'index.html' in the 'About' section in the front page of the repository.

  • Provide a link to 'index.html' in README.md .

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions