Skip to content
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.

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

docs: fix an issue where it goes into an infinite loop when building #4596

Merged
merged 3 commits into from
Nov 6, 2023

Conversation

thomasheartman
Copy link
Contributor

@thomasheartman thomasheartman commented Sep 1, 2023

This change sets noRuntimeDownloads to true for
plugin-remote-content' to avoid the infinite loop issue mentioned in
rdilweb/docusaurus-plugin-remote-content#51,
as described in
https://github.com/rdilweb/docusaurus-plugin-remote-content#noruntimedownloads.

Note that this will require you to generate the files before
running the doc build, which may be more an issue, so it's a tradeoff.

To generate the files before building run:

yarn docusaurus download-remote-content-external
yarn docusaurus download-remote-content-sdks

We can of course write a simpler command that does this for us (or even make it part of the build step). In fact, I think we'll need to do exactly that. It seems to be failing now because the files are not generated by default by the build steps.

Creating this PR mostly to get feedback from @dgorton. What do you think?

This change sets `noRuntimeDownloads` to `true` for
`plugin-remote-content'` to avoid the infinite loop issue mentioned in
rdilweb/docusaurus-plugin-remote-content#51,
as described in
https://github.com/rdilweb/docusaurus-plugin-remote-content#noruntimedownloads.

I suspect that this will require you to generate the files before
running the doc build, which may be an issue. However, this does stop
the doc from building over and over.
@vercel
Copy link

vercel bot commented Sep 1, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 2, 2023 9:52am
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 2, 2023 9:52am

@thomasheartman
Copy link
Contributor Author

@dgorton Have you had a chance to have a look at this? Have any thoughts?

dgorton
dgorton previously approved these changes Oct 10, 2023
Copy link
Contributor

@dgorton dgorton left a comment

Choose a reason for hiding this comment

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

Apologies for the delay on this - missed this notification.

@dgorton dgorton dismissed their stale review October 10, 2023 16:03

Let's get the build documentation as well.

@dgorton
Copy link
Contributor

dgorton commented Oct 10, 2023

Fixing infinite loops is obviously a good thing. It would be nice not to add more steps to the build process, however - especially as this will likely catch people by surprise.

Are you comfortable adding these commands as part of the build step, per your comment?

To generate the files before building run:

yarn docusaurus download-remote-content-external
yarn docusaurus download-remote-content-sdks

We can of course write a simpler command that does this for us (or even make it part of the build step). In fact, I think we'll need to do exactly that. It seems to be failing now because the files are not generated by default by the build steps.

@thomasheartman
Copy link
Contributor Author

Yeah, good points. I think it should be pretty straightforward. Should look something like d0d9da8. Let's see if that works.

website/package.json Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants