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(docs): hardcode Tile deprecation, fix console errors #4341

Merged
merged 1 commit into from
Oct 25, 2024

Conversation

evwilkin
Copy link
Member

@evwilkin evwilkin commented Oct 25, 2024

Closes #4339
Closes #4176
Closes #4340

FYI - Line changes linked due to additional prettier formatting changes.

This PR:

  • Fixes console errors:

    • error thrown by missing key prop in CSSVariables table. (cssVariables.js line 15)
    • error thrown by use of class rather than className in the site footer. (footer.js line 270)
  • Hard-codes "Tile" to be deprecated:

    • Adds "deprecated" label to the Sidenav item (sideNav.js line 169)
      • Explanation: sidenav label isn't added if either the React or Core examples aren't marked deprecated, this line bypasses that check specifically for the Tile component.
    • Adds inline alert to the top of each Tile docs page (mdx.js line 125)
      • Explanation: Inline deprecation alert is only added on Core page if examples exist in a /deprecated/ directory, this bypasses that specifically for the Tile component.
    • Adds TODO comments to remove these hard-coded updates when Core #7178 is merged. (sideNav.js && mdx.js)

@patternfly-build
Copy link
Contributor

{(deprecated ||
source === 'react-deprecated' ||
source === 'html-deprecated' ||
// TODO: remove hardcoded Tile when Core PR merges
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we open a follow up issues so we don't forget to do this?

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you! Created here - #4343

@tlabaj tlabaj merged commit f2a8ce7 into patternfly:main Oct 25, 2024
4 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
4 participants