Skip to content

chore: Docusaurus with webpack 5 #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
slorber wants to merge 5 commits into from
Closed

chore: Docusaurus with webpack 5 #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
210226c
upgrade docu
slorber Apr 23, 2021
45714c1
fix links
slorber Apr 23, 2021
4e2cea4
pdate
slorber Apr 30, 2021
f0cdf2a
Merge branch 'master' into slorber/docusaurus-webpack5
slorber Apr 30, 2021
00cccd0
Merge branch 'master' into slorber/docusaurus-webpack5
slorber May 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/CrossCompilation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ This process is currently happened in different places for different platforms:

1. For Android, this happened in `hermes/android/build.gradle`
2. For Apple platforms, this happend in `hermes/utils/build-apple-framework.sh`
3. For Emscripten, you can find an example from the `test-emscripte` job from `hermes/.circleci/config.yml`. Also see more details at [Building with Emscripten](../emscripten)
3. For Emscripten, you can find an example from the `test-emscripte` job from `hermes/.circleci/config.yml`. Also see more details at [Building with Emscripten](./Emscripten.md)
Copy link
Copy Markdown
Contributor

@Huxpro Huxpro May 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm guessing this is better because it works on both github.com and hermes website (with Docusaurus replacing the link to the correct url)?

Copy link
Copy Markdown
Contributor Author

@slorber slorber May 4, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docusaurus has a broken links checker now and this URL was reported as broken.

In general, I think it's a bad idea to link using relative URL paths, because it makes the link sensitive to your host provider adding an extra slash at the end of an URL or not (it is not something very std and lead to a ton of reported problems in all Jamstack frameworks) (our issue: facebook/docusaurus#3372)

Relative file paths are resolved to absolute URLs by Docusaurus at build time, so this is not sensitive to the host adding a trailing slash.

Copy link
Copy Markdown
Contributor Author

@slorber slorber May 4, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(and yes, it also works on Github 👍 )

Copy link
Copy Markdown
Contributor

@Huxpro Huxpro May 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh thanks for providing that context. I certainly fought with trailing slash appended by github pages before: https://twitter.com/Huxpro/status/798816417097224193

2 changes: 1 addition & 1 deletion doc/Emscripten.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ WARNING: The old `fastcomp` backend was [removed in emscripten `2.0.0` (August 2
Hermes now requires a two stage build proecess because the VM now contains
Hermes bytecode which needs to be compiled by Hermes.

Please follow the [Cross Compilation](../CrossCompilation) to set up a workplace
Please follow the [Cross Compilation](./CrossCompilation.md) to set up a workplace
and build a host hermesc at `$HERMES_WS_DIR/build_host_hermesc`.


Expand Down
8 changes: 4 additions & 4 deletions website/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
"clear": "docusaurus clear"
},
"dependencies": {
"@docusaurus/core": "^2.0.0-alpha.69",
"@docusaurus/preset-classic": "^2.0.0-alpha.69",
"@docusaurus/core": "2.0.0-alpha.75",
Copy link
Copy Markdown
Contributor

@Huxpro Huxpro May 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be really strict. Is taking minor release w/ ^ bad?

Copy link
Copy Markdown
Contributor Author

@slorber slorber May 4, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not bad, it's just that after my tests using canary 2.0.0-alpha.hash somehow using ^ did not make yarn download alpha75 and the lockfile stayed on the canary version (probably because my version name is bad)

I can revert to ^ if you want but keep in mind we force users to have all core package versions aligned.
We'll add a "docusaurus upgrade" cli anyway so it does not matter much, up to you

Copy link
Copy Markdown
Contributor

@Huxpro Huxpro May 5, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. No need to revert. We can always change that if we really need to.

"@docusaurus/preset-classic": "2.0.0-alpha.75",
"classnames": "^2.2.6",
"monaco-editor": "^0.19.2",
"react": "^16.8.4",
"react-dom": "^16.8.4",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-monaco-editor": "^0.33.0"
},
"browserslist": {
Expand Down
Loading