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

Upgrade to Docusaurus v3 #355

Closed
ElliotFriend opened this issue Mar 6, 2024 · 5 comments
Closed

Upgrade to Docusaurus v3 #355

ElliotFriend opened this issue Mar 6, 2024 · 5 comments
Assignees
Labels
bug Something isn't working

Comments

@ElliotFriend
Copy link
Contributor

ElliotFriend commented Mar 6, 2024

Docusaurus v3 is out now, and (pending a plugin update) we should be using it.

More context and thoughts:

  • the particular plugin we've been waiting on is docusaurus-openapi-docs, which is working on a v3 upgrade. it's possible using one of the v3.0.0-beta.x releases will be suitable
  • We should also take this time to make sure all of our tooling, gh actions, package.json, .nvmrc, whatever else are using a consistent version of nodejs (v20 seems ideal)
@waldmatias
Copy link
Contributor

When this happens... could we please enable "es" support for i18n? We would be more than happy to provide es-versions of the entire docs in preparation for greater LATAM awareness of Stellar.

@ElliotFriend
Copy link
Contributor Author

Hi, @waldmatias!! I started typing a "brief" comment that got a lot longer than I expected hehe

TL;DR: We're actively considering how to support "es" translation for our technical docs.

That's an excellent request! We're actually in the process of evaluating exactly that option! They're currently working on providing Spanish-language i18n for the main www.stellar.org site. The Spanish translations aren't yet available, but I'm told they should be viewable in the next couple weeks or so? (don't quote me on that timeline precisely lol).

I don't know the specifics of how they're translating everything, but it has something to do with automating it with ChatGPT. The process has been proofed/checked/refined by folks who natively speak Spanish, though not with a technical background. Once those pages are live and available, I'd be really curious to hear your impression of it (especially since you're really familiar with Stellar). I can't speak Spanish any further than counting to 10 and asking where the restroom is, so I can't really speak to its quality 🤷🏻‍♂️

@waldmatias
Copy link
Contributor

Thanks @ElliotFriend, good to see work is already under way. Though I have to say, it has been my experience that translations for technical-oriented (specific) materials still yield the best results (and less rework) when tackled manually. I would be happy to proofread some of the material once there's at least a draft.
In any case, concerning implementation for v3 Docusaurus, you need no go further than checking out pnpm's docs:
https://github.com/pnpm/pnpm.io/blob/main/docusaurus.config.js#L308 to get some ideas.

@ElliotFriend
Copy link
Contributor Author

Yeah, I'm interested to see how feasible the automated system is, too.

I'm SO GLAD you shared that link to pnpm's docs repo. I didn't know they used docusaurus, and it looks like there are some really useful techniques we might be able to use along the way (even non-translation stuff). Thank you!!

@ElliotFriend
Copy link
Contributor Author

With #405 merged in, we're ready to proceed onward and upward to docusaurus v3! 🎉

@ElliotFriend ElliotFriend moved this from Backlog to In Progress in Dev Docs Apr 30, 2024
@ElliotFriend ElliotFriend changed the title Consider upgrade path for Docusaurus Upgrade to Docusaurus v3 Apr 30, 2024
@janewang janewang moved this from In Progress to Blocked in Dev Docs May 7, 2024
@briwylde08 briwylde08 moved this from Blocked to In Progress in Dev Docs Jul 2, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Dev Docs Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: No status
Development

No branches or pull requests

3 participants
@ElliotFriend @waldmatias and others