fix(v2): deprecate docs homePageId in favor of frontmatter "slug: /" #3228
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
|
Deploy preview for docusaurus-2 ready! Built with commit 57f8623 |
slorber
added
pr: maintenance
Addono
added a commit
to unveiler-io/developer-website
that referenced
this pull request
Sep 12, 2020
|
Will this be added to categories @slorber ? We would like to avoid using frontmatter for certain docs we are generating. |
|
@gabrielcsapo I don't understand what you mean by "added to categories" here. About frontmatter, I plan to add a generic |
|
That would be awesome @slorber! This would be similar to editUrl function in the config? |
|
Not sure what you mean by "similar", but in a sense yes it will also be a callback giving you additional control, to inject/filter/replace/enhance the frontmatter of any doc |
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.
Motivation
homePageIdis not the best solution, as it is global across all versions. If we want to update the id of the home docs of current version, this will break the homepage for former version.Frontmatter
slug: /is more reliable, quite intuitive, and allows to set a different homepage for each version independently. Versions become more easily "sandboxed"Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Tests + Dogfooding