Move docs node generation to a local plugin #3113
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
6 tasks
julieg18
approved these changes
Dec 20, 2021
gatsby-config.js
Outdated
| { | ||
| resolve: 'gatsby-theme-iterative-docs', | ||
| options: { | ||
| docComponent: require.resolve('./src/templates/doc.tsx'), |
There was a problem hiding this comment.
Where is the docComponent being used in the theme? I'm not seeing it being used anywhere 🤔
There was a problem hiding this comment.
Whoops! I renamed this to defaultTemplate in createPages but didn't end up updating it here.
rogermparent
temporarily deployed
to
dvc-org-docs-gatsby-nod-dqjul0
yathomasi
reviewed
Dec 21, 2021
rogermparent
temporarily deployed
to
dvc-org-docs-gatsby-nod-dqjul0
rogermparent
temporarily deployed
to
dvc-org-docs-gatsby-nod-dqjul0
iesahin
pushed a commit
that referenced
this pull request
Apr 11, 2022
* Move docs node generation to a local plugin * Use pluginOptionsSchema API for defaults * Remove unused import
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 is a first step in porting our docs engine into a reusable Gatsby theme. It moves all the files from our docs Gatsby Model to a new local plugin at
plugins/gatsby-theme-iterative-docs.From here, we can continue to move more parts of our docs engine (sidebar, components) to this plugin directory. Once we have everything moved and ensure it still works, we can turn the local plugin folder into its own node module and start work on reintegrating it with the other sites.