[lexical-website] Documentation Update: Validate stackblitz URLs in documentation #6215
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
facebook-github-bot
added
the
CLA Signed
etrepum
commented
May 30, 2024
| @@ -100,7 +100,7 @@ function Editor() { | |||
|
|
|||
| Source code: [examples/react-rich-collab](https://github.com/facebook/lexical/tree/main/examples/react-rich-collab) | |||
|
|
|||
| <iframe width="100%" height="600" src="https://stackblitz.com/github/facebook/lexical/tree/fix/collab_example/examples/react-rich-collab?embed=1&file=src%2FApp.tsx&terminalHeight=0&ctl=1&showSidebar=0&devtoolsheight=0&view=preview" sandbox="allow-forms allow-modals allow-popups allow-popups-to-escape-sandbox allow-presentation allow-same-origin allow-scripts"></iframe> | |||
| <iframe width="100%" height="600" src="https://stackblitz.com/github/facebook/lexical/tree/main/examples/react-rich-collab?embed=1&file=src%2FApp.tsx&terminalHeight=0&ctl=1&showSidebar=0&devtoolsheight=0&view=preview" sandbox="allow-forms allow-modals allow-popups allow-popups-to-escape-sandbox allow-presentation allow-same-origin allow-scripts"></iframe> | |||
There was a problem hiding this comment.
This is an example of a case where we have left a non-main branch reference in an example (this isn't an isolated incident, I have fixed this class of inconsistency several times in various other PRs)
size-limit report 📦
|
etrepum
commented
May 30, 2024
| @@ -161,7 +161,7 @@ | |||
| "eslint-plugin-sort-keys-fix": "^1.1.2", | |||
| "flow-bin": "^0.226.0", | |||
| "fs-extra": "^10.0.0", | |||
| "glob": "^7.2.0", | |||
| "glob": "^10.4.1", | |||
There was a problem hiding this comment.
I think this should be safe, if not we'll find out pretty quickly in tests. The upgrade is required to use an array of glob patterns, if it causes problems I will revert this part and use flatMap.
etrepum
requested review from
zurfyx,
fantactuka,
acywatson,
Fetz,
ivailop7,
Sahejkm and
potatowagon
as code owners
|
I went ahead and added the follow-up considerations to this PR to save some time in creating another one. I'm done now :) |
StyleT
approved these changes
May 31, 2024
etrepum
added a commit
to etrepum/lexical
that referenced
this pull request
May 31, 2024
This was referenced Jun 26, 2024
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.
Description
Sometimes we publish stackblitz URLs that point to a branch and don't change it back to main after review, which means examples can go stale or break if that branch is deleted.
To make PR review of stackblitz URLs easier, and to make the examples stable (relevant to #6144), this also adds docusaurus markdown preprocessor to rewrite these URLs on build to point to a specific commit (for PRs) or release branch.
Test plan
Before
stackblitz URLs could point to branches other than main
After
Tests fail if a stackblitz URL does not point to main
Stackblitz URLs reference a specific commit for PRs so they can be tested in situ