Skip to content

Commit

Permalink
trying to host the docs here as well
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris McIntosh committed Jun 4, 2021
1 parent 6364509 commit 503e2dc
Show file tree
Hide file tree
Showing 83 changed files with 53 additions and 53 deletions.
46 changes: 46 additions & 0 deletions README.docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Migrating to GitHub Actions Facilitator 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.

## Deploy the manual

This guid is currently deployed to GitHub pages and [can be found here](https://githubtraining.github.io/actions-facilitator-guide/)

If you would like to contribute to the guide follow the steps in the **Preview changes on your machine** section.

<!--
These manuals are designed to be generated using [docsify](https://docsify.js.org). To get your own manuals up and running, all you have to do is:
1. Fork this repository
2. In your fork, click on **Settings**
3. Scroll down to the GitHub Pages section, and set **Source:** to `master branch /docs folder`.
4. Click **Save**.
5. Return to the GitHub Pages section of Settings, and you'll receive the URL of your published manual.
-->

## Make changes

The official [docsify documentation](https://docsify.js.org/#/?id=docsify) 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/`](docs/) folder of this repository. All content is written in Markdown, and it's all stitched together in [`docs/_sidebar.md`](docs/_sidebar.md), which specifies the order and hierarchy of the content.

#### Mermaid-js

This manual makes use of [mermaid-js](https://mermaid-js.github.io/mermaid/#/) 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](https://mermaid-js.github.io/mermaid/#/stateDiagram) 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.

## Preview changes on your machine

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](https://docsify.js.org/#/quickstart) guide.

**steps:**

1. `npm i docsify-cli -g`
2. `docsify serve docs`

View the locally running version of this guide at `http://localhost:3000`
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
46 changes: 7 additions & 39 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,14 @@
# Migrating to GitHub Actions Facilitator Guide
# Welcome to GitHub Actions

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.
![welcome-actions](https://user-images.githubusercontent.com/6351798/82074464-074e7880-9698-11ea-84e2-200e49485f5c.png)

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.

## Deploy the manual
Today is a very exciting day as it marks the beginning of your adventure with GitHub Actions!

This guid is currently deployed to GitHub pages and [can be found here](https://githubtraining.github.io/actions-facilitator-guide/)
As we move through these materials, please keep the following in mind: this class is for you! Be sure to follow along, participate in the activities, and ask lots of questions!

If you would like to contribute to the guide follow the steps in the **Preview changes on your machine** section.
This content is used for the GitHub Actions and Migrations trainings with GitHub Professional Services. To learn more, visit https://services.github.com/.

<!--
These manuals are designed to be generated using [docsify](https://docsify.js.org). To get your own manuals up and running, all you have to do is:
---

1. Fork this repository
2. In your fork, click on **Settings**
3. Scroll down to the GitHub Pages section, and set **Source:** to `master branch /docs folder`.
4. Click **Save**.
5. Return to the GitHub Pages section of Settings, and you'll receive the URL of your published manual.
-->

## Make changes

The official [docsify documentation](https://docsify.js.org/#/?id=docsify) 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/`](docs/) folder of this repository. All content is written in Markdown, and it's all stitched together in [`docs/_sidebar.md`](docs/_sidebar.md), which specifies the order and hierarchy of the content.

#### Mermaid-js

This manual makes use of [mermaid-js](https://mermaid-js.github.io/mermaid/#/) 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](https://mermaid-js.github.io/mermaid/#/stateDiagram) 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.

## Preview changes on your machine

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](https://docsify.js.org/#/quickstart) guide.

**steps:**

1. `npm i docsify-cli -g`
2. `docsify serve docs`

View the locally running version of this guide at `http://localhost:3000`
👈 Click **Getting Started** to begin!
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 0 additions & 14 deletions docs/docs/README.md

This file was deleted.

File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 503e2dc

Please sign in to comment.