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

feat: Update Docusaurus from v2 to v3 #690

Merged
merged 4 commits into from
Dec 19, 2023

Conversation

disha1202
Copy link
Contributor

What kind of change does this PR introduce?

feature

Issue Number:

Fixes #685

Did you add tests for your changes?

No

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Update Docusaurus from v2 to v3

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?

Yes

Copy link

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests and there are no merge conflicts.

The process helps maintain accurate and well-formatted documentation and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

@disha1202
Copy link
Contributor Author

Hi @palisadoes,
Updated docusaurus from v2 to v3.
Please take a look.

@palisadoes
Copy link
Contributor

These files must be excluded from the upgrade because:

  1. They are autogenerated by pull requests in the other repos
  2. They represent code blocks that should be left unchanged.

Please fix.

  1. Verify whether the error-handling.md file renders like we have on the site when finished.
  2. Do the same with a representative sample of the other files.

image

@palisadoes
Copy link
Contributor

I just read the documentation and realized that the escaping of the characters in the 300+ files may be necessary.

Please verify whether the files rendered in your PR look the same as the rendering on the site. This is important to know with and without the mdx3 conversion so that we can alter our automated documentation workflows.

@tasneemkoushar, @anwersayeed FYI upgrading to Docusaurus v3 may cause issues with our workflows. This PR with the conversions seems to be escaping some javacript and HTML tags.

Details here:

@palisadoes
Copy link
Contributor

palisadoes commented Nov 23, 2023

I'm getting this error when clicking through on some of the pages especially after switching tabs (Please fix and maintain the animation):

image

The pages themselves seem OK, but I'd like the others to test this too. Please do your own tests.

@palisadoes
Copy link
Contributor

Please merge the latest upstream/develop branch with your branch. It has a fix for the links to the broken Talawa-Admin and Talawa-API documentation.

@disha1202
Copy link
Contributor Author

I'm getting this error when clicking through on some of the pages especially after switching tabs (Please fix and maintain the animation):

image

The pages themselves seem OK, but I'd like the others to test this too. Please do your own tests.

Sure, will look into it.

@disha1202
Copy link
Contributor Author

I am unable replicate the error above, can you specify the exact steps and pages that lead to this error.

Also while testing I came across some formatting issues which are not there in V2.

Screenshot 2023-11-23 at 3 27 38 PM Screenshot 2023-11-23 at 3 25 14 PM

I am working on fixing these right now.

@palisadoes
Copy link
Contributor

The error occurs when I load the site in Opera

image

@palisadoes
Copy link
Contributor

This error when loading in Firefox:

image

@palisadoes
Copy link
Contributor

This error when loading in Chrome

image

@disha1202
Copy link
Contributor Author

Thanks, I was able to reproduce the issue on my local.
Also I believe this issue exists on https://docs.talawa.io/ as well, as there is no element with the class LogoAnimation

@palisadoes
Copy link
Contributor

Please take the necessary steps to rectify this

@tasneemkoushar
Copy link
Contributor

@Nitya-Pasrija can you once check this PR, if the changes are breaking any of the workflow.

Copy link
Contributor

@Nitya-Pasrija Nitya-Pasrija left a comment

Choose a reason for hiding this comment

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

I am seeing major changes in the yarn.lock file. Please do not make any such changes here as it can break the application flow and do look into it that you have followed all the correct steps while cloning the repository.

@palisadoes
Copy link
Contributor

I am seeing major changes in the yarn.lock file. Please do not make any such changes here as it can break the application flow and do look into it that you have followed all the correct steps while cloning the repository.

@Nitya-Pasrija The docusaurus upgrade process requires extensive package updates to package.json which will automatically affect yarn.lock, correct?

It'll be important for you to review that page to see how the new MDX markdown format will affect the workflows you worked on earlier.

@anwersayeed anwersayeed self-requested a review December 9, 2023 19:37
@palisadoes
Copy link
Contributor

palisadoes commented Dec 18, 2023

We should merge this PR. It's been too long

@anwersayeed @tasneemkoushar how will the new version impact our automated workouts from dart docs, TS docs and graphql explorer

I want to make sure we don't have any additional documentation update issues because of this

@palisadoes palisadoes merged commit 4a61b62 into PalisadoesFoundation:develop Dec 19, 2023
3 checks passed
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.

Upgrade Talawa-Docs to Docusaurus v3.0
5 participants