The Documentation files and Docusaurus source code reside in two different repositories. The final webpage requires both in order to be deployed.
Depends on
[x] #1323
[x] #1318
[x] #1317
[x] #1316
Solution
Refactor the GitHub workflow inside the new repo. The goal of that workflow is to generate a single-page website from the contents of the docs directory in the development branch of Ampersand. The workflow should be triggered any time when there is a new commit/merge/pull request of the development branch of Ampersand. Use github pages to serve this single-page website. Use Docusaurus as a generator.
Either:
- [ ] Refactor CI/CD pipeline in "DocuGen" repo to trigger on push to development branch in "Ampersand" repo
Or:
- [ ] Create a CI/CD pipeline in "Ampersand" repo to trigger on push and deploy the Docusaurus website in the "DocuGen" repo
[x] DocuGen contains DeployToPages.yml, a GitHub Action which retrieves the "docs" folder from Ampersand and deploys the Docusaurus Website to GitHub Pages.
[x] Ampersand contains triggerDocsUpdate.yml, a GitHub Action which triggers DeployToPages.yml on a push to the development (main) branch when changes are made to the "docs" folder.
Problem Definition
The Documentation files and Docusaurus source code reside in two different repositories. The final webpage requires both in order to be deployed.
Depends on
Solution
Refactor the GitHub workflow inside the new repo. The goal of that workflow is to generate a single-page website from the contents of the docs directory in the development branch of Ampersand. The workflow should be triggered any time when there is a new commit/merge/pull request of the development branch of Ampersand. Use github pages to serve this single-page website. Use Docusaurus as a generator.
Either:- [ ] Refactor CI/CD pipeline in "DocuGen" repo to trigger on push to development branch in "Ampersand" repoOr:- [ ] Create a CI/CD pipeline in "Ampersand" repo to trigger on push and deploy the Docusaurus website in the "DocuGen" repo