-
-
Notifications
You must be signed in to change notification settings - Fork 667
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: docs versioning and i18n #1527
Conversation
ab4d6bf
to
a442020
Compare
@pd93 Awesome work! Thanks for taking the time to do these improvements. I have two small details to discuss:
![]() We don't necessarily need to fix on this PR (can be in another one), but I would consider 1) make these social network links into icon-only links (the Docusaurus website itself does this); or 2) Remove Twitter, Mastodon and Discord and keep only GitHub (and perhaps Discord) which is/are the most important.
![]() |
I had noticed this, but was going to raise another issue/discussion as there are a few things we could do to improve the navbar. I generally agree with your first choice of moving towards icons instead of text links. There are also some other things I had considered:
Screenshot of all these changes: Wdyt about these icons?
My understanding is that it should just work? But I'm not entirely sure. If we want to test it, we can do a deployment to a staging site on this PR with the new command |
f27e0ff
to
86c733d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The site is looking great, thanks!
I'd just change the icons to be in the following order (most important first): GitHub, Discord, Twitter, Mastodon.
Unrelated, but I'd like to consider renaming the top level docs folder in the repo to website as the website encompasses more than just documentation now. This follows the structure in Docusaurus' own repo. The docs/docs hierarchy also stutters a bit.
It looks like a good idea to me!
bb0e0de
to
8323179
Compare
This PR solves a couple of issues with documentation versioning and internationalisation.
The problems:
The solutions:
latest
: Represents the latest released version of Task and will only be updated when a release is made. This will be the default when opening our websitenext
: Represents all the tip of ourmain
branch and contains all the latest changes. Users would have to explicitly select "Next 🚧" from the versions drop-down on the website to view this. Docusaurus also automatically adds a banner to the top of every page warning users that this functionality has not been released.This PR also updates the release tool so that the "latest" version is automatically updated when a maintainer create a new release.
docs/i18n
folder and remove thesync-translated-documents
workflow from the repository. Instead, we should update the command that Netlify runs when it builds the documentation to pull the translations from Crowdin. This is how the Docusaurus documentation actually suggests this should be done.Note that this PR puts in place all the changes required for this to work (I think?). However, the command will need updating in Netlify to actually apply this change, otherwise the site will be deployed without any translations. The command will need updating to
npx crowdin download && npx docusaurus build