Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move documentation to a book format #2448

Merged
merged 10 commits into from
Aug 17, 2020
Merged

Move documentation to a book format #2448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
81cbca3
Move documentation to a dedicated book.
ehuss Aug 6, 2020
bdb44d4
Add book introduction.
ehuss Aug 6, 2020
ceedb97
Some editorial changes to the installation chapters.
ehuss Aug 6, 2020
7044699
New content and tweaks for the concepts chapters.
ehuss Aug 6, 2020
56d60c6
Add introduction to basics chapter.
ehuss Aug 6, 2020
59f5eb1
Update and extend the overrides chapter.
ehuss Aug 6, 2020
8dd80fb
Update faq for fetching rust source.
ehuss Aug 6, 2020
d30f9d9
Minor tweaks and some links.
ehuss Aug 6, 2020
61dc06c
Link the Rust security policy.
ehuss Aug 6, 2020
bffbf66
Add book deploy in CI.
ehuss Aug 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/deploy-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Deploy Docs

on:
push:
branches:
- master

jobs:
doc:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install mdbook
run: |
mkdir mdbook
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.1/mdbook-v0.4.1-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
echo ::add-path::`pwd`/mdbook
- name: Build book
run: cd doc && mdbook build
- name: Deploy to GitHub
run: |
cd doc/book
git init
git config user.name "Deploy from CI"
git config user.email ""
git add . .nojekyll
git commit -m "Deploy $GITHUB_SHA to gh-pages"
git remote add origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
git push --force --set-upstream origin master:gh-pages
Loading