Infrastructure for building unversioned pages from the stable version. #1107
Conversation
This file contains hidden or 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
The only file changed in the move is the root `docs.json` file. Instead a `v2.json` file was added.
|
A live preview of this PR will be available at the URL(s) below. https://pr1107-132a32c---lit-dev-5ftespv5na-uc.a.run.app/ |
AndrewJakubowicz
force-pushed
the
version-v2
branch
from
f46efaf to
43a8f18
Compare
This copies over and adds the correct permalinks to the selected version content. Currently moving `v2` -> `unversioned`.
AndrewJakubowicz
force-pushed
the
version-v2
branch
from
43a8f18 to
19a07fb
Compare
AndrewJakubowicz
force-pushed
the
version-v2
branch
from
cb5bcd5 to
e56c92b
Compare
Unversioned links will be generated automatically by the generated unversioned pages.
This works by piping all the content through a function that will fix cross links on unversioned pages.
AndrewJakubowicz
requested review from
augustjk and
justinfagnani
and removed request for
justinfagnani and
augustjk
The versioned URL is stripped for unversioned URLs by our tooling. Add a test to confirm this behavior.
augustjk
reviewed
May 11, 2023
augustjk
approved these changes
May 11, 2023
- Replaced sync fs with async fs. - Made lightweight YAML parser more robust using regex.
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.
Issue with design and background: #1108
Testing
This was extensively manually tested. E.g., any
/docs/v2links were checked for the presence of arel=canonicallink.v1or unversioned pages do not have rel=canonical.Similarly cross links were checked on
docs/v2/apianddocs/api.Also added some integration tests as smoke testing for the features added.