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

chore: bump Docusaurus to v3 #1176

Merged
merged 11 commits into from
Sep 3, 2024
Merged

chore: bump Docusaurus to v3 #1176

merged 11 commits into from
Sep 3, 2024

Conversation

barjin
Copy link
Contributor

@barjin barjin commented Sep 2, 2024

Following the bump of @apify/docs-search-modal to Docusaurus v3, this PR bumps the Docusaurus dependency version in @apify/docs-theme and the Apify Docs themselves.

This is required for Docusaurus version bump in all the subprojects (SDK docs, Client docs etc.)

The changes follow the official v3 migration guide.

@barjin barjin added the adhoc Ad-hoc unplanned task added during the sprint. label Sep 2, 2024
@barjin barjin self-assigned this Sep 2, 2024
@barjin barjin requested a review from B4nan September 2, 2024 10:08
@github-actions github-actions bot added this to the 97th sprint - Tooling team milestone Sep 2, 2024
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Sep 2, 2024
- <https://python.langchain.com/docs/integrations/providers/apify>
- <https://python.langchain.com/docs/integrations/tools/apify>
- <https://python.langchain.com/docs/modules/model_io/llms/>
- [https://python.langchain.com/docs/get_started/introduction](https://python.langchain.com/docs/get_started/introduction)
Copy link
Member

Choose a reason for hiding this comment

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

do we really need to do this? i thought this is enough

Suggested change
- [https://python.langchain.com/docs/get_started/introduction](https://python.langchain.com/docs/get_started/introduction)
- https://python.langchain.com/docs/get_started/introduction

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Uh oh, apparently the markdown linter in the CI checks doesn't like bare URLs.

And the apparent fix is to enclose it in angle brackets, isn't that convenient 🙃

I'm all for bare URLs; you're right that writing the same URL twice makes it less readable (i.e., not really what using linter should do). I'll check what we can do to disable this rule in markdownlint - is that okay with you @TC-MO ?

@B4nan
Copy link
Member

B4nan commented Sep 3, 2024

we will also need to wait for milesj/docusaurus-plugin-typedoc-api#156 to be merged/released, or alter those imports via patch package, some projects like the js SDK use versioning and this will pop up in those

@barjin
Copy link
Contributor Author

barjin commented Sep 3, 2024

Right, I already fixed this (for Python Crawlee) in our fork of that package, but you're right that we're using the original package in the JS projects.

Maybe it's time to switch the JS projects to our fork too? Once we want to make some changes to how the rendered docs look like (you know, the ones that I was promising since 6 months ago), we can deploy it over all our projects at once (Python and JS alike).

@B4nan
Copy link
Member

B4nan commented Sep 3, 2024

yeah, if its still compatible with js projects, lets do that

Copy link
Member

@B4nan B4nan left a comment

Choose a reason for hiding this comment

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

lgtm

} from '@docusaurus/theme-common/internal';
} from '@docusaurus/plugin-content-docs/client';
import { ThemeClassNames } from '@docusaurus/theme-common';
import { useHomePageRoute } from '@docusaurus/theme-common/internal';
Copy link
Member

Choose a reason for hiding this comment

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

i thought the /internal imports are no longer allowed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From what I understood, the Docusaurus team removed some theme-common package dependencies, as they didn't make sense from the "big-picture" POV. The theme-common/internal module was reexporting some of the symbols from those dependencies, which then indeed stopped working.

The useHomePageRoute hook is defined inside of theme-common, though, so it still works. Honestly, I don't really like importing something called internal either, but... as long as it works, I guess I'm fine?

Copy link
Member

Choose a reason for hiding this comment

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

yeah sure, that's why I gave you the checkmark right ahead, build is passing, so it's fine.

@barjin barjin merged commit 13f0942 into master Sep 3, 2024
7 checks passed
@barjin barjin deleted the chore/bump-docusaurus-v3 branch September 3, 2024 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants