Skip to content

Commit a1975ad

Browse files
authored
docs: switch docs to mdbook (#15)
Signed-off-by: Ali Mukadam <ali.mukadam@oracle.com>
1 parent c3c1c01 commit a1975ad

File tree

599 files changed

+1602
-46018
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

599 files changed

+1602
-46018
lines changed

.github/workflows/hugo.yml

Lines changed: 0 additions & 80 deletions
This file was deleted.

.github/workflows/mdbook.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Publish Terraform OCI VCN Module Book
2+
on:
3+
# Rebuild docs when a release is published
4+
release:
5+
types: [published]
6+
# Enable manual trigger
7+
workflow_dispatch:
8+
9+
jobs:
10+
build-and-publish-book:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
with:
15+
fetch-depth: 0
16+
- name: Install mdbook
17+
run: |
18+
mkdir mdbook
19+
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.21/mdbook-v0.4.21-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
20+
echo `pwd`/mdbook >> $GITHUB_PATH
21+
cargo install mdbook-admonish
22+
- name: Deploy Book to GitHub Pages
23+
run: |
24+
# Build the HTML content
25+
mdbook build -d book/ docs/
26+
27+
# Create and switch to the gh-pages work tree
28+
git worktree add gh-pages gh-pages
29+
cd $GITHUB_WORKSPACE/gh-pages
30+
31+
git config user.name "GitHub Actions"
32+
git config user.email "oci-dax-tools_ww@oracle.com"
33+
34+
# Delete the ref to avoid keeping history.
35+
git update-ref -d refs/heads/gh-pages
36+
rm -rf *
37+
38+
mv $GITHUB_WORKSPACE/docs/book/* $GITHUB_WORKSPACE/gh-pages
39+
touch $GITHUB_WORKSPACE/gh-pages/.nojekyll
40+
41+
git add .
42+
git commit -m "Deploy $GITHUB_SHA to gh-pages"
43+
git push --force-with-lease

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,6 @@ provider.tf
1313
generated/**
1414

1515
# visual code
16-
**/.vscode/*
16+
**/.vscode/*
17+
18+
docs/book/*

docs/.hugo_build.lock

Whitespace-only changes.

docs/archetypes/default.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/book.toml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[book]
2+
authors = ["The Terraform OCI Verrazzano Module contributors"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "Terraform module for Verrazzano"
7+
8+
[preprocessor.admonish]
9+
command = "mdbook-admonish"
10+
assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
11+
12+
[output.html]
13+
curly-quotes = false
14+
git-repository-url = "https://github.com/oracle-terraform-modules/terraform-oci-verrazzano"
15+
additional-css = ["./src/css/mdbook-admonish.css", "././mdbook-admonish.css"]
16+
17+
[output.html.playground]
18+
editable = true

docs/config.toml

Lines changed: 0 additions & 32 deletions
This file was deleted.

docs/content/dns/_index.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/content/mc/_index.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/content/mc/pri-ep.md

Lines changed: 0 additions & 143 deletions
This file was deleted.

0 commit comments

Comments
 (0)