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

Add schema documentation autogenerate and deploy to CircleCi #54

Open
mjtravers opened this issue Mar 18, 2022 · 0 comments
Open

Add schema documentation autogenerate and deploy to CircleCi #54

mjtravers opened this issue Mar 18, 2022 · 0 comments
Assignees

Comments

@mjtravers
Copy link
Contributor

mjtravers commented Mar 18, 2022

Generates schema documentation in CircleCI and deploys it to gh-pages branch

generates-schema-documentation-in-circleci-and-deploys-it-to-gh-pages-branch

generates-schema-documentation-in-circleci-and-deploys-it-to-gh-pages-branch

Tech notes

https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#creating-a-custom-github-actions-workflow-to-publish-your-site

tech-notes

tech-notes

  • See api#40 for configuration example
  • Look at the Sphinx ticket above.

Acceptance Criteria

acceptance-criteria

acceptance-criteria

  • After a merge to develop, the data dictionary documentation is updated with any schema changes

QA Notes

null

DEV Notes

null

Design

null

See full ticket and images here: FECFILE-110

@mjtravers mjtravers changed the title Create a git hook to autogenerate schema HTML documentation Add schema documentation autogenerate and deploy to CircleCi Apr 27, 2022
@mjtravers mjtravers added the DevOps DevOps focused issue label Apr 27, 2022
@AureliaKhorsand AureliaKhorsand removed the DevOps DevOps focused issue label Mar 12, 2024
@AureliaKhorsand AureliaKhorsand added ADTR and removed ADTR labels Mar 27, 2024
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

3 participants