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

Update Docusaurus to v3, initial pruning of docs and setup for FASTElement 2.0.0 #6947

Merged

Conversation

janechu
Copy link
Collaborator

@janechu janechu commented May 3, 2024

Pull Request

πŸ“– Description

This pull request does the following:

  • Updates docusaurus to v3
    • This necessatated some editing of the docs as they were not compliant with the mdx format, a document checker has been added to the package.json scripts
  • Remove docs in v2.0.0 that had links to documents that will not be included in the v2.0.0 documentation site
  • Rename "legacy" to 1.0.0 for clarity (this still includes documentation for removed packages but documentation site going forward will only refer to the @microsoft/fast-element package version and document that package).
  • Removal and simplification of some legacy React components made for Docusaurus.
  • Some decoupling from dependencies in the mono-repository, these are all devDependencies, simple configuration updates, or small TypeScript changes.

πŸ‘©β€πŸ’» Reviewer Notes

This is only the initial step to get the documentation site to be versioned, have a limited @microsoft/fast-element documentation, and be on the latest docusaurus version. Still needed is updating the documentation itself, this will occur in future PRs prior to versioning @microsoft/fast-element to 2.0.0.

Edit: One of the issues with this update is that any updates to the package dependencies is very difficult (to put it mildly), yarn 1 does not react appropriately to nohoisting and fixing versions with "resolution" in the root level package.json has over time caused a bit of a rats nest. This has caused me to have to change some of the tsconfig files and skip the foundation toolbar tests as well as explicitly fix and add certain package dependencies to force packages to build and test correctly. Please look at the changes with a critical eye, but know that many of these changes were done only to get this change in, and that there are plans to upgrade to npm and remove yarn as a dependency after some cleanup to the project which will make that process much easier.

βœ… Checklist

General

  • I have included a change request file using $ yarn change
  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@janechu janechu self-assigned this May 3, 2024
Copy link
Collaborator

@KingOfTac KingOfTac left a comment

Choose a reason for hiding this comment

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

Only thing I noticed was the mermaid charts not rendering on the introduction pages for both v1 and v2

@janechu
Copy link
Collaborator Author

janechu commented May 5, 2024

Only thing I noticed was the mermaid charts not rendering on the introduction pages for both v1 and v2

Good catch, I'll make another PR before I update content to get the mermaid charts working, looks like that was changed between docusaurus versions.

@scomea
Copy link
Collaborator

scomea commented May 6, 2024

Under "community contributions v2" -
image

@scomea
Copy link
Collaborator

scomea commented May 6, 2024

Builds fine for me. Did a very cursory initial pass on content.

@janechu janechu merged commit 4b23b5c into master May 9, 2024
10 checks passed
@janechu janechu deleted the users/janechu/upgrade-docusaurus-v3-remove-redundant-docs branch May 9, 2024 16:46
janechu added a commit that referenced this pull request May 22, 2024
# Pull Request

## πŸ“– Description

Pursuant to [PR comment](#6947 (review)), this enables mermaid diagrams to be displayed with the new docusaurus v3 update.

## βœ… Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [ ] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](/docs/community/code-of-conduct/#our-standards) for this project.
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.

None yet

5 participants