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

Fix clean-api-docs not deleting sidebar.ts #829

Merged
merged 1 commit into from
Jun 14, 2024

Conversation

MarcL01
Copy link
Contributor

@MarcL01 MarcL01 commented May 22, 2024

Description

Motivation and Context

Running clean-api-docs doesn't delete the generated sidebar.ts file, this causes the file to not carry over changes when gen-api-docs is ran. For now I have install & use rimraf to delete the sidebar.ts docusaurus clean-api-docs all && rimraf <path>/sidebar.ts

How Has This Been Tested?

Used the local version of this branch in my typescript Docusaurus project, and confirmed clean-api-docs now deletes the sidebar.ts file without needing rimraf.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Updates the glob string used to match sidebar files.
Originally "sidebar.js" was used. I updated it to "sidebar.{js,ts}"
You can test this glob here

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@sserrata sserrata merged commit 1b8c879 into PaloAltoNetworks:main Jun 14, 2024
10 checks passed
Copy link

Visit the preview URL for this PR (updated for commit 4775bc0):

https://docusaurus-openapi-36b86--pr829-wg1umsju.web.app

(expires Sun, 14 Jul 2024 14:59:56 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

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

2 participants