From 65a7d96644eaefaf2823dbced62046ccd466197a Mon Sep 17 00:00:00 2001 From: Will Hunt Date: Mon, 29 Nov 2021 10:26:11 +0000 Subject: [PATCH] Add skeleton for docs --- .github/workflows/docs.yml | 29 +++++++++++++++++++++++++++++ .gitignore | 2 ++ book.toml | 6 ++++++ docs/SUMMARY.md | 9 +++++++++ docs/features.md | 1 + docs/hookshot.md | 1 + docs/setup.md | 0 docs/setup/github.md | 1 + docs/setup/gitlab.md | 1 + docs/setup/jira.md | 1 + docs/setup/webhooks.md | 1 + 11 files changed, 52 insertions(+) create mode 100644 .github/workflows/docs.yml create mode 100644 book.toml create mode 100644 docs/SUMMARY.md create mode 100644 docs/features.md create mode 100644 docs/hookshot.md create mode 100644 docs/setup.md create mode 100644 docs/setup/github.md create mode 100644 docs/setup/gitlab.md create mode 100644 docs/setup/jira.md create mode 100644 docs/setup/webhooks.md diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..1529c5af --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,29 @@ +name: Build docs + +on: + push: + branches: + - main + + workflow_dispatch: + +jobs: + deploy: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2 + + - name: Setup mdBook + uses: peaceiris/actions-mdbook@v1 + with: + mdbook-version: '0.4.11' + + - run: mdbook build + + - name: Deploy latest + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + keep_files: true + publish_dir: ./book + destination_dir: ./ \ No newline at end of file diff --git a/.gitignore b/.gitignore index 35d99c6a..e94b6dec 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ public/ .idea # Added by cargo /target + +book \ No newline at end of file diff --git a/book.toml b/book.toml new file mode 100644 index 00000000..18c99568 --- /dev/null +++ b/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Half-Shot "] +language = "en" +multilingual = false +src = "docs" +title = "Matrix Hookshot" diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 00000000..0bcf410a --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,9 @@ +# Summary + +- [Hookshot](./hookshot.md) +- [Features](./features.md) +- [Setup](./setup.md) + - [GitHub](./setup/github.md) + - [GitLab](./setup/gitlab.md) + - [JIRA](./setup/jira.md) + - [Webhooks](./setup/webhooks.md) \ No newline at end of file diff --git a/docs/features.md b/docs/features.md new file mode 100644 index 00000000..ead02231 --- /dev/null +++ b/docs/features.md @@ -0,0 +1 @@ +# Features diff --git a/docs/hookshot.md b/docs/hookshot.md new file mode 100644 index 00000000..b743fda3 --- /dev/null +++ b/docs/hookshot.md @@ -0,0 +1 @@ +# Chapter 1 diff --git a/docs/setup.md b/docs/setup.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/setup/github.md b/docs/setup/github.md new file mode 100644 index 00000000..c27f9530 --- /dev/null +++ b/docs/setup/github.md @@ -0,0 +1 @@ +# GitHub diff --git a/docs/setup/gitlab.md b/docs/setup/gitlab.md new file mode 100644 index 00000000..7a0c76d1 --- /dev/null +++ b/docs/setup/gitlab.md @@ -0,0 +1 @@ +# GitLab diff --git a/docs/setup/jira.md b/docs/setup/jira.md new file mode 100644 index 00000000..82c1cd2a --- /dev/null +++ b/docs/setup/jira.md @@ -0,0 +1 @@ +# JIRA diff --git a/docs/setup/webhooks.md b/docs/setup/webhooks.md new file mode 100644 index 00000000..ac597c1c --- /dev/null +++ b/docs/setup/webhooks.md @@ -0,0 +1 @@ +# Webhooks