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.

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

文件系統 #21

Closed
3 tasks done
toomore opened this issue Jul 25, 2023 · 0 comments · Fixed by #25
Closed
3 tasks done

文件系統 #21

toomore opened this issue Jul 25, 2023 · 0 comments · Fixed by #25
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@toomore
Copy link
Collaborator

toomore commented Jul 25, 2023

#18 所討論使用 mdbook 來建立。

待確定項目:

  • 是否針對文件額外建立新的 repo,或是將文件部分存放在 ./docs 底下。
  • Hosting: Github or where?
  • Github actions for generating the docs.

Host on Github

  1. Create branch: docs
  2. Github Actions (trigger by push to main)
  3. mdbook build in Github Actions, and push to branch: docs with GITHUB_DEPLOY_KEY

ref: Automated Deployment: GitHub Actions

Result

https://oscvpass.ocf.tw/docs/

nojekyll

Add .nojekyll in the root source.

ref: Static site generators

@toomore toomore converted this from a draft issue Jul 25, 2023
@toomore toomore added mails Send mails documentation Improvements or additions to documentation and removed mails Send mails labels Jul 25, 2023
@toomore toomore moved this from 🆕 New to 🏗 In progress in OSCVPass Project Aug 1, 2023
@toomore toomore linked a pull request Aug 8, 2023 that will close this issue
@toomore toomore moved this from 🏗 In progress to 👀 In review in OSCVPass Project Aug 8, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in OSCVPass Project Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants