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

GitHub: Update help.yml #24868

Merged
merged 21 commits into from
Nov 21, 2023
Merged

GitHub: Update help.yml #24868

merged 21 commits into from
Nov 21, 2023

Conversation

joevaugh4n
Copy link
Contributor

Closes #

What I did

  • Fixed the help template not working
  • Made tweaks to the layout (after seeing what it looked like in prod, wanted to change a few things around)

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!

• Open up a help discussion
• Form should now work as syntax errors are resolved

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>

Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Left some suggestions and comments to address. Ping me when you're ready, and I'll merge for ya!

@kylegach kylegach changed the title Update help.yml GitHub: Update help.yml Nov 16, 2023
@kylegach kylegach added build Internal-facing build tooling & test updates ci:docs Run the CI jobs for documentation checks only. labels Nov 16, 2023
@joevaugh4n
Copy link
Contributor Author

Left some suggestions and comments to address. Ping me when you're ready, and I'll merge for ya!

Hey @kylegach, thanks for the great feedback. Committed it. Unless there's anything else that I missed, please feel free to merge!

Copy link
Contributor

@vanessayuenn vanessayuenn left a comment

Choose a reason for hiding this comment

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

The content looks good to me. But it looks like there are still some errors with the formatting 😬

label: Share an example
description: Help us debug your issue by creating a minimal reproduction. You can do this with StackBlitz by heading to [https://storybook.new](https://storybook.new)!
label: Create a reproduction
description: Help us debug by creating a minimal reproduction with [https://storybook.new](https://storybook.new)
Copy link
Contributor

Choose a reason for hiding this comment

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

We can add this link here also in case it's helpful: https://storybook.js.org/docs/react/contribute/how-to-reproduce

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey @vanessayuenn – I tried the edited code in a different forked version of Storybook and it looks like it works (pic below).

I can't get rid of the error messages in this branch – they don't even make sense because they refer to bits of code that aren't there. E.g. it says 'body[0]: validations is not a permitted attribute', but there isn't a validations attribute within that first key.

Any thoughts? Could we try merging and see if that resolves it/changes the errors?

CleanShot 2023-11-17 at 14 10 01@2x

.github/DISCUSSION_TEMPLATE/help.yml Outdated Show resolved Hide resolved
joevaugh4n and others added 3 commits November 20, 2023 15:53
- Remove `render` attribute from Additional information textarea
    - That property will force input into a code block, but we're asking for information that would best fit in multiple code blocks
- Add `id` for debugging purposes
- Attempt to fix formatting issues
@kylegach
Copy link
Contributor

@joevaugh4n — I pushed a commit with some minor updates.

Looking more closely at those errors, they match the file that's on the next branch. It appears to be a bug in the GitHub UI that those errors appear when viewing a different branch, like this one. 🤷‍♂️

As far as I can tell, the file in this PR fixes all of those errors. So, I think you're good to go! I'm going to merge it.

@kylegach kylegach merged commit 24aaab8 into next Nov 21, 2023
16 checks passed
@kylegach kylegach deleted the joevaugh4n-sb-help branch November 21, 2023 04:21
@github-actions github-actions bot mentioned this pull request Nov 21, 2023
36 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Internal-facing build tooling & test updates ci:docs Run the CI jobs for documentation checks only.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants