Skip to content

Commit

Permalink
feat(docs): Adding mdBook (#2638)
Browse files Browse the repository at this point in the history
* feat(docs): Adding mdBook

* chore(docs): Moving docs

* feat(docs): Adding summary

* feat(docs): Updating CI
  • Loading branch information
professionalRuker committed Oct 23, 2023
1 parent 48a81c0 commit 88ef911
Show file tree
Hide file tree
Showing 61 changed files with 86 additions and 15 deletions.
24 changes: 17 additions & 7 deletions .github/workflows/deploy-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,17 @@ jobs:
- run: yarn
# - run: yarn build:admin
- run: yarn src/docs build

- name: Install latest mdbook
run: |
tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
mkdir mdbook
curl -sSL $url | tar -xz --directory=./mdbook
echo `pwd`/mdbook >> $GITHUB_PATH
- name: Build Book
run: cd src/book && mdbook build

# - uses: FirebaseExtended/action-hosting-deploy@v0
# with:
Expand All @@ -47,9 +57,9 @@ jobs:
# target: admin-f3635
# entryPoint: "./src/admin"

- uses: FirebaseExtended/action-hosting-deploy@v0
with:
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_CEZERIN_8FAB8 }}"
repoToken: "${{ secrets.GITHUB_TOKEN }}"
projectId: cezerin-8fab8
entryPoint: "./src/docs"
# - uses: FirebaseExtended/action-hosting-deploy@v0
# with:
# firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_CEZERIN_8FAB8 }}"
# repoToken: "${{ secrets.GITHUB_TOKEN }}"
# projectId: cezerin-8fab8
# entryPoint: "./src/docs"
26 changes: 18 additions & 8 deletions .github/workflows/deploy-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,17 @@ jobs:
- run: yarn
# - run: yarn build:admin
- run: yarn src/docs build

- name: Install latest mdbook
run: |
tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
mkdir mdbook
curl -sSL $url | tar -xz --directory=./mdbook
echo `pwd`/mdbook >> $GITHUB_PATH
- name: Build Book
run: cd src/book && mdbook build

# - uses: FirebaseExtended/action-hosting-deploy@v0
# with:
Expand All @@ -49,10 +59,10 @@ jobs:
# target: admin-f3635
# entryPoint: "./src/admin"

- uses: FirebaseExtended/action-hosting-deploy@v0
with:
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_CEZERIN_8FAB8 }}"
repoToken: "${{ secrets.GITHUB_TOKEN }}"
projectId: cezerin-8fab8
channelId: live
entryPoint: "./src/docs"
# - uses: FirebaseExtended/action-hosting-deploy@v0
# with:
# firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_CEZERIN_8FAB8 }}"
# repoToken: "${{ secrets.GITHUB_TOKEN }}"
# projectId: cezerin-8fab8
# channelId: live
# entryPoint: "./src/docs"
1 change: 1 addition & 0 deletions src/book/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book
6 changes: 6 additions & 0 deletions src/book/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[book]
authors = ["Himadu2000"]
language = "en"
multilingual = false
src = "src"
title = "Cezerin"
43 changes: 43 additions & 0 deletions src/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Summary

- [Introduction](./introduction.md)

# Getting Started

- [Overview](getting-started/overview.md)
- [Online Demo](getting-started/online-demo.md)
- [Application Structure](getting-started/application-structure.md)
<!-- - [API Client](https://github.com/cezerin2/cezerin2-client)
- [API Reference](https://github.com/Cezerin2/Cezerin2/tree/main/docs/api) -->

# Installation Guides

- [Prerequisites](installation-guides/prerequisites.md)
- [Setup Database](installation-guides/setup-database.md)
- [Using source code](installation-guides/using-source-code.md)
- [Using docker](installation-guides/using-docker.md)

# Deploy on Web

- [Hosting](deploy-on-web/deploy-on-web-hosting.md)
- [Create droplet](deploy-on-web/deploy-on-web-droplet.md)
- [Setup domain](deploy-on-web/deploy-on-web-domain.md)
- [Install NGinx Web Server + MERN Stack](deploy-on-web/deploy-on-web-mern.md)
- [Run MongoDB](deploy-on-web/deploy-on-web-mongodb.md)
- [Run Cezerin](deploy-on-web/deploy-on-web-cezerin.md)
- [Run NGinx](deploy-on-web/deploy-on-web-nginx.md)
- [Cezerin configs changes](deploy-on-web/deploy-on-web-cezerin-configs.md)
- [Final checks](deploy-on-web/deploy-on-web-final-checks.md)
- [Setup Let's Encrypt SSL Certificate](deploy-on-web/deploy-on-web-lets-encrypt.md)
- [Turn off Developer Mode](deploy-on-web/deploy-on-web-production-mode.md)

<!-- # API
- [API Reference](api)
- [API Client](https://github.com/cezerin2/cezerin2-client) -->

# Help

- [FAQ](help/faq.md)
- [HowTos](help/howtos.md)
- [Help and Support](help/help-and-support.md)
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
1 change: 1 addition & 0 deletions src/book/src/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Introduction

0 comments on commit 88ef911

Please sign in to comment.