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 docusaurus version to beta.6 #1713

Merged
merged 1 commit into from
Sep 9, 2021

Conversation

KyrietS
Copy link
Member

@KyrietS KyrietS commented Sep 8, 2021

What does this PR do?

Upgrade Docusaurus from alpha.70 to beta.6. I'd like to try a new Docusaurus' feature for sidebars auto-generation at some point in the future. This PR is my first step towards it.

How does this PR change Premake's behavior?

From Docusaurus perspective there are 2 changes that had to be made:

  • Every file prefixed with an underscore is ignored so I had to rename some files: _OPTIONS.md, _OS.md etc. I used premake prefix for them.
  • A path /docs/tags/ is reserved by Docusaurus. I had to use different URL for tags.md.

Anything else we should know?

Everything should work as before.

Did you check all the boxes?

  • Focus on a single fix or feature; remove any unrelated formatting or code changes
  • Add unit tests showing fix or feature works; all tests pass
  • Mention any related issues (put closes #XXXX in comment to auto-close issue when PR is merged)
  • Follow our coding conventions
  • Minimize the number of commits
  • Align documentation to your changes

You can now support Premake on our OpenCollective. Your contributions help us spend more time responding to requests like these!

- some files had to be renamed as files prefixed with an underscore are ignored now
- docusaurus reserves /docs/tags path so we can't have a page there
Copy link
Member

@nickclark2016 nickclark2016 left a comment

Choose a reason for hiding this comment

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

I'm happy to have us move out an alpha dependency. +1

@KyrietS
Copy link
Member Author

KyrietS commented Sep 9, 2021

Yup, Docusaurus was in alpha for quite a long time, and now they announced that they are going to deprecate v1, so beta.6 is the best we can have now :-)

I also asked them how to prevent Docusaurus from reserving a docs/tags path (facebook/docusaurus#5542) and they were kind enough to immediately create PR and add this feature 😄 So hopefully my hack won't be necessary in beta.7.

@nickclark2016
Copy link
Member

Should we wait for beta.7 then?

@KyrietS
Copy link
Member Author

KyrietS commented Sep 9, 2021

Nah, it's not that important. I'll merge it for now

@KyrietS KyrietS merged commit bfafd86 into premake:master Sep 9, 2021
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.

2 participants