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

Documentation folder structure + publication process #176

Open
Miles-Garnsey opened this issue Nov 25, 2020 · 0 comments
Open

Documentation folder structure + publication process #176

Miles-Garnsey opened this issue Nov 25, 2020 · 0 comments
Assignees

Comments

@Miles-Garnsey
Copy link
Collaborator

Miles-Garnsey commented Nov 25, 2020

Summary

The documentation folder structure could be simplified, as currently ASCIIDoc components reside within manual/, while the published documentation resides within doc/.

This is probably to work around the fact that github.io (the documentation hosting mechanism) will only publish pages from the project root, or a folder called doc/.

Proposed changes

I suggest that we modify the documentation publication process, so that -

  • The documentation is published out of the project root on a separate branch (which we'll call site-publish).
  • Documentation sources reside within doc/.
  • A branch called site-staging is created at every pull request to enable review.
  • When a pull request is approved, site-staging is promoted to site-publish via Github actions (or CircleCI if preferred).
@Miles-Garnsey Miles-Garnsey self-assigned this Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant