search

patternfly / patternfly-quickstarts

Repository containing the PatternFly Quick Start extension code
MIT License
15 stars 38 forks source link

PatternFly.org quick starts content edits #205

Closed edonehoo closed 1 year ago

edonehoo commented 1 year ago

Closes https://github.com/patternfly/patternfly-org/issues/3234

Reviews and edits content for quick starts and in app documentation.

netlify[bot] commented 1 year ago

Deploy Preview for quickstarts ready!

Name Link
Latest commit 8fc0adf7a1204aa074bd7defe60b49e69eee0f8d
Latest deploy log https://app.netlify.com/sites/quickstarts/deploys/640a16a8372aaa00086442fc
Deploy Preview https://deploy-preview-205--quickstarts.netlify.app/
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

edonehoo commented 1 year ago

First round of edits. I could add more specific documentation for the examples if that would be valuable, but I already made a lot of edits and didn't want to get too ahead of myself.

abigaeljamie commented 1 year ago

Thank you, @edonehoo !

@jessiehuff , are you the person who can merge this for us? I always tag Margot to merge design guidelines, but since this doc is for extensions, I'm not sure who the right person is 🙂

edonehoo commented 1 year ago

hi! @evwilkin could you let me know if my latest change uses tabName properly? Also - I know your issue/pr is merged and closed, but is the code change fully live? Meaning: once my edits are good to go can I merge and close this pr?

evwilkin commented 1 year ago

@edonehoo you'll want to keep the source frontmatter field as that is not optional, but the additional tabText will override it when the text is displayed to ensure the correct text/spacing formatting.

My PR was merged into the @patternfly/documentation-framework repo so is live and available to use as of version 1.7.0 which should work as expected when these docs are added to the PF website. As for which version of the documentation-framework is used when you're building locally, @dlabaj or @wise-king-sullyman may be of more help here - it looks like the devDependency is locked in to a prior version which may affect how these updates display for you locally.

wise-king-sullyman commented 1 year ago

Yeah as I understand it the locked version would make this not work properly locally, but after a quick swing at opening the versioning up to get those recent changes in didn't go well as it caused other dependency issues.

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 2.4.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket: