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

refactor: Docusaurus to version 3.7 #499

Draft
wants to merge 21 commits into
base: master
Choose a base branch
from

Conversation

asr2003
Copy link

@asr2003 asr2003 commented Jan 29, 2025

No description provided.

Copy link

netlify bot commented Jan 29, 2025

👷 Deploy request for permitio-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 55fcaa3

@asr2003 asr2003 marked this pull request as draft January 29, 2025 20:19
@asr2003
Copy link
Author

asr2003 commented Jan 29, 2025

@gemanor Just a note to update ARGOS_TOKEN as secrets

@asr2003
Copy link
Author

asr2003 commented Jan 29, 2025

I will now upgrade Docusaurus to v7 and push their changes too and here the breaking change is it doesn't support prefix(/) like v1/a in sidebars need to fix this

@gemanor
Copy link
Collaborator

gemanor commented Jan 31, 2025

@asr2003 that sounds good. We actually planning anyway to remove the v1.0.0 and redirect it to the home page of the current docs.

@filipermit please set up the docs repo with Argos token

@asr2003
Copy link
Author

asr2003 commented Jan 31, 2025

@gemanor Can I remove the v1 docs and push a separate PR or can I get any upstream PR. It will make most of the work easy of this migration

@asr2003
Copy link
Author

asr2003 commented Jan 31, 2025

@gemanor @filipermit Here you need to get login this project in Argo portal then the workflow get access to run

https://app.argos-ci.com

@filipermit
Copy link
Collaborator

@asr2003 Thanks for the PR - I will run and test it today, and come back with any feedback I may have. V1 docs need to remain for reference to an older version. We might remove it at some point, but for the time being they need to stay.

@gemanor
Copy link
Collaborator

gemanor commented Feb 1, 2025

@filipermit afaik we already discussed about removing v1 (as it's not available to anyone anymore)

Please check with @danielbass37

@gemanor
Copy link
Collaborator

gemanor commented Feb 3, 2025

Hey, @asr2003, any news with the version update and the errors you experienced there?
Also, @filipermit, please update here when you're done with the Argos token

@asr2003
Copy link
Author

asr2003 commented Feb 3, 2025

@gemanor Yes, I have updated few changes from version changes but I am just waiting on conformance whether we need v1 prefix sidebar or remove and get work easy

@gemanor
Copy link
Collaborator

gemanor commented Feb 4, 2025

You can remove the v1 (just need to make sure it has relevant redirects)

@gemanor
Copy link
Collaborator

gemanor commented Feb 6, 2025

Hey @asr2003 , @filipermit , any news here?

@asr2003
Copy link
Author

asr2003 commented Feb 6, 2025

@gemanor Just a conformation that I am trying to remove whole v1 directory and from sidebars too. Is this fine to goo?

@gemanor
Copy link
Collaborator

gemanor commented Feb 7, 2025

Yeah, I just approved it :)

@gemanor
Copy link
Collaborator

gemanor commented Feb 7, 2025

You can remove anything related to 1.0.0 from the repo, just make sure the pages has redirects

@asr2003 asr2003 changed the title refactor: Docusaurus to version 7 refactor: Docusaurus to version 3.7 Feb 8, 2025
@asr2003
Copy link
Author

asr2003 commented Feb 8, 2025

@gemanor Mostly done the critical breaking changes to update to v3 from v2 and here the error occurring during build is due to version static build generation. I think you need to approve workflow to get your eye on it

And another change is :::warning has changed to yellow color if it's ok with it i will keep it without any changes and if we need red color we need to change to :::danger

Once this two are done we are set to go now directly to update from v3 to v3..7

@gemanor
Copy link
Collaborator

gemanor commented Feb 8, 2025

during build is due to version static build generation

Approved the workflow but still not sure what is that mean :)

Can you elaborate please?

@asr2003
Copy link
Author

asr2003 commented Feb 9, 2025

@gemanor Can you approve workflow now? You will exactly see the issue what I am intending to tell in docusaurus build stage

@gemanor
Copy link
Collaborator

gemanor commented Feb 10, 2025

Hey, I'm not sure what kind of help you need here, I guess the build error is something related to the upgrade - not something related to the content, right?

@asr2003
Copy link
Author

asr2003 commented Feb 11, 2025

Yes, I will try to find root cause of it

@gemanor
Copy link
Collaborator

gemanor commented Feb 11, 2025

Also see the comment in the issue page

@asr2003
Copy link
Author

asr2003 commented Feb 13, 2025

@gemanor I have found the issue of it why it not tying to build. I will fix it in weekend and push the code. I have my university exams for next 2 days. Will be back on it on Sunday.

Meanwhile maybe we can merge the Argos workflow into master as I mentioned in issue comment

@filipermit
Copy link
Collaborator

@gemanor I have found the issue of it why it not tying to build. I will fix it in weekend and push the code. I have my university exams for next 2 days. Will be back on it on Sunday.

@asr2003 Sounds good, we will be waiting for it.

Meanwhile maybe we can merge the Argos workflow into master as I mentioned in issue comment

I think we want to wait until everything passes. @gemanor can confirm here, but it seems like the more reasonable thing to do, especially for giving us the ability to test end-to-end.

@gemanor
Copy link
Collaborator

gemanor commented Feb 13, 2025

@asr2003 can you please open a PR with only Argos and Playwright (without version upgrade) so we can check if it passes and then we can merge it?

@asr2003
Copy link
Author

asr2003 commented Feb 13, 2025 via email

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