[APT-1557] Add local docs source #64
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…y. TODO: Update the ref to not be pointed to a branch but to a tagged release version! Added nodemon that will re-run the local regeneration code on each save and automatically redeploy the docs site.
…mirrors the top level `docs/` folder which now only has "generated" content. Updated all generated content to now be actually automatically generated.
eak12913
requested review from
bwhaley,
robmorgan and
yorinasub17
as code owners
|
✔️ Deploy Preview for pensive-meitner-faaeee ready! 🔨 Explore the source changes: 7163191 🔍 Inspect the deploy log: https://app.netlify.com/sites/pensive-meitner-faaeee/deploys/61a6dd2d2b9f6e0008baf48d 😎 Browse the preview: https://deploy-preview-64--pensive-meitner-faaeee.netlify.app |
oredavids
previously approved these changes
Nov 30, 2021
oredavids
approved these changes
Dec 1, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new
_docs-sources/folder that contains the true markdown source files which comprise the manually written content of the docs site.Content creators can now add content into the
_docs-sources/folder. Internally this folder has the same structure as will be outputted into the top leveldocs/folder. All source files will be subject to pre-processing by being put through thedocs-sourcer.There's a new
yarncommand:yarn regenerate:local. This command can be used to run the pre-processor on the local source files.While working, Grunts should still use the usual
yarn startto launch a local dev server. This command has now been modified to also scan the new_docs-sourcerdirectory and automatically re-run the pre-processor for any changes/updates.