** # Deprecated please do not follow links in this guide**
Welcome to the Migrating to GitHub Actions offering repo. In this repo, you will find the content used by GitHub during our official actions training and consulting.
If you have access to this repository, it is because your company has an agreement with GitHub to use these materials. Your use of these materials is described by that agreement.
This guid is currently deployed to GitHub pages and can be found here
If you would like to contribute to the guide follow the steps in the Preview changes on your machine section.
The official docsify documentation is your best bet for getting up to speed with the tool.
In general, you'll find all of the manual content in the docs/ folder of this repository. All content is written in Markdown, and it's all stitched together in docs/_sidebar.md, which specifies the order and hierarchy of the content.
This manual makes use of mermaid-js specifically for the use of stateDiagram. Should you need to update, or want to add, a new stateDiagram using this library will allow the custom CSS to be applied for consistency.
Any diagrams can be written directly in markdown with the mermaid syntax however it is important to note that docsify and mermaid struggle to work well together, so once a new stateDiagram is created it is best to save a screenshot of it and use it within the markdown vs the raw mermaid chart.
Doing so will prevent mermaid from breaking as you go to a new page.
You can install, and serve the contents of the docs/ folder locally with minimal setup. The steps are thoroughly described in the doscify quick start guide.
steps:
npm i docsify-cli -gdocsify serve docs
View the locally running version of this guide at http://localhost:3000