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

🤖 Extend the documentation workflow #90

Open
1 of 7 tasks
pschmitt opened this issue Nov 19, 2021 · 1 comment
Open
1 of 7 tasks

🤖 Extend the documentation workflow #90

pschmitt opened this issue Nov 19, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Issue that are great for first-time contributors maintenance Task to maintain project in a working state
Milestone

Comments

@pschmitt
Copy link
Member

pschmitt commented Nov 19, 2021

We need CI for the really boring stuff: zsdoc, manpage, PDF. Otherwise they will get out of sync. Should be fairly trivial to add.
In CI we can generate all of these and ship them to the repo.

It think these artifacts can be stored in the gh-pages branch. Keeping them as build artifacts is sadly not an option because of the max lifetime of these (90 days?). Let me know if there's a more appropriate place for these.

TODO:

  • Rename and extend the gh-pages workflow
  • Move the files living in the documentation branch (mkdocs) to the main one
  • On-push generation of the zsdoc
  • On-push generation of the PDF
  • Remove the *.adoc, zsdoc/ etc from the main branch
  • Update any link pointing to the aforementioned doc artifacts
  • Update instructions in doc/README.md

Refs:

@pschmitt pschmitt added 🤖 ci good first issue Issue that are great for first-time contributors maintenance Task to maintain project in a working state labels Nov 19, 2021
@pschmitt pschmitt added this to the zinit 4.0 milestone Nov 19, 2021
@pschmitt pschmitt added the documentation Improvements or additions to documentation label Nov 19, 2021
@daehyeok
Copy link
Contributor

daehyeok commented Dec 6, 2021

#127 Automatically parsing and update package list also will be good.
Do you have any plan to use other language for automation(e.g Python)?

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 good first issue Issue that are great for first-time contributors maintenance Task to maintain project in a working state
Projects
None yet
Development

No branches or pull requests

3 participants