GitHub Pages publish guide

[mickmcgrath13]

Closes #

closes #22710

What I did

Updated documentation for publishing Storybook to GitHub Pages

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

[jonniebigodes]

@mickmcgrath13 thanks for taking the time to put together this pull request and help us improve the documentation. We appreciate it 🙏 ! However, before we can get this properly reviewed and added to the documentation, there's a bit of an issue that I've raised in the Action repo.

Would love to hear your thoughts so that this can be thoroughly reviewed and merged into the documentation.

Looking forward to hearing from you.

Hope you have a fantastic day.

Stay safe.

[mickmcgrath13]

thanks @jonniebigodes! I responded, and we should be able to knock it out quickly.

[jonniebigodes]

@mickmcgrath13 I saw it and followed up with you on it. Looking forward to seeing the update so that we can get this one updated as well and merged in.

[mickmcgrath13]

@jonniebigodes We've got a new releasea: v1.0.1!

This release adds the install_command option and some readme notes to show how to use yarn instead of npm.

I've also updated the docs in this PR to reflect the new version

[mickmcgrath13]

@jonniebigodes Are there any other updates you'd like to see before merging this in?

[jonniebigodes]

@mickmcgrath13 first and foremost, sorry for the delayed response, here. But I had a chance to use the updated version of the Action and it's looking great. Appreciate you addressing the feedback so promptly. Regarding this pull request, I left a couple of suggestions for you to look into and follow up with me so that we can get this one wrapped up and merged soon.

Looking forward to hearing your thoughts.

Have a fantastic day.

Stay safe

[mickmcgrath13]

@jonniebigodes We made the updates based on your recommendations (all great, btw!).

Please let me know if there are any further changes you'd like to see

[mickmcgrath13]

@jonniebigodes It looks like there's a couple of failing docs tests. Are you able to tell me specifically what they're unhappy about?

[jonniebigodes]

@mickmcgrath13 just a few minor tweaks for you to look into, and this is good to go. Also, once you've addressed them, can you run yarn pretty-docs before committing the changes? That should fix the failing tests (it's a prettier check to verify that the snippets are well formatted).

Let me know once you've addressed them and I'll take a look and hopefully merge this one.

Have a great day.

[mickmcgrath13]

can you run yarn pretty-docs before committing the changes

ran before latest commit: abb7942

[mickmcgrath13]

@jonniebigodes 🎉 pretty-docs passed!

[jonniebigodes]

@mickmcgrath13, and we're good to go. Cannot thank you for taking the time to put together this pull request and willingness to coordinate with us and get the documentation updated. Appreciate it 🙏

I'll get it merged once the checklist clears.

Hope you have a fantastic rest of the week.

Stay safe

[mickmcgrath13]

<3