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

Move the Hyde documentation files to this repo to be able to sync changes to master branch #367

Closed
caendesilva opened this issue May 16, 2022 · 3 comments

Comments

@caendesilva
Copy link
Member

Right now it's a bit tricky to deploy updates to the documentation that are timed to releases.

If the docs are updated to early I end up having documentation that has features that don't yet exist, if I do it after I may forget to update them.

Thinking a good or at least better way to solve this is to add a docs directory here, and propagate changes to the docs repo. Changes in the docs repo are also synced here. This introduces complexity since the docs repo is also synced to DocsCI. Here I am thinking that when running the CI building process, a job in the action downloads the latest documentation files.

@caendesilva
Copy link
Member Author

Or better, once a release is published, then the docs get updated. While there is a delay of a few minutes (more if there are merge conflicts) it could be a better implementation.

Or, even even better if I (or someone who sees this) can design a workflow for it keeps the contents of the docs here in sync with a new "upcoming" branch of the docs, which can then be merged when a release is published (or just before)

@caendesilva
Copy link
Member Author

Note to self: remember to add the docs directory to export-ignore

@caendesilva
Copy link
Member Author

Think for now I may add a dev-docs directory here, and sync it to a dev branch on the docs repo. I can then trigger merge manually there.

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