Skip to content

Conversation

@edonehoo
Copy link
Contributor

@edonehoo edonehoo commented Nov 1, 2022

Closes patternfly/patternfly-org#3234

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

@netlify
Copy link

netlify bot commented Nov 1, 2022

Deploy Preview for quickstarts ready!

Name Link
🔨 Latest commit 8fc0adf
🔍 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
Copy link
Contributor Author

edonehoo commented Nov 1, 2022

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
Copy link

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 🙂

id: Quick starts
# Tab
source: In-App-Documentation
source: In\-app-documentation
Copy link
Contributor

@jessiehuff jessiehuff Nov 18, 2022

Choose a reason for hiding this comment

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

I think the \ might be a typo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was actually trying to escape the hyphen so that it would show up on the site as "In-app documentation" instead of "In app documentation"! It seemed like hyphens in the code weren't showing on the site, but I also wasn't sure if I understood how the webpage was building correctly. Do you know if that understanding is correct and if there's a way to make hyphens show?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hi @jessiehuff wanted to loop back around on this question when you have a chance!

@edonehoo
Copy link
Contributor Author

edonehoo commented Mar 9, 2023

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
Copy link
Member

evwilkin commented Mar 9, 2023

@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.

Copy link
Member

@evwilkin evwilkin left a comment

Choose a reason for hiding this comment

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

LGTM

@wise-king-sullyman
Copy link
Contributor

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.

Copy link
Contributor

@jessiehuff jessiehuff left a comment

Choose a reason for hiding this comment

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

LGTM! We'll create a follow up issue for the build concerns.

@jessiehuff jessiehuff merged commit 6e7683e into patternfly:main Mar 23, 2023
@github-actions
Copy link

🎉 This PR is included in version 2.4.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug - Revise quick starts & in-app documentation extension documentation

5 participants