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

Fixes the description about id key in Issue Forms. #9045

Merged
merged 115 commits into from
Aug 24, 2021
Merged

Fixes the description about id key in Issue Forms. #9045

merged 115 commits into from
Aug 24, 2021

Conversation

thispsj
Copy link
Contributor

@thispsj thispsj commented Aug 15, 2021

Why:

Closes #9004

What's being changed:

The id key is used in issue forms with every type (excluding markdown). But the docs mention that the attributes key should contain it which is wrong. The id key is a top-level key in each type.

Check off the following:

  • I have reviewed my changes in staging (look for the latest deployment event in your pull request's timeline, then click View deployment).
  • For content changes, I have completed the self-review checklist.

Fixes #9004

The `id` key is the top level key and has been misplaced in the `attributes` key. Luckily the examples do not have any such error,
@ghost ghost temporarily deployed to docs-9045--fixforms August 15, 2021 10:28 Inactive
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 15, 2021
@thispsj thispsj marked this pull request as ready for review August 15, 2021 14:08
@ghost ghost temporarily deployed to docs-9045--fixforms August 15, 2021 14:27 Inactive
@ghost ghost temporarily deployed to docs-9045--fixforms August 15, 2021 18:19 Inactive
@ghost ghost temporarily deployed to docs-9045--fixforms August 15, 2021 22:15 Inactive
@ghost ghost temporarily deployed to docs-9045--fixforms August 16, 2021 02:46 Inactive
@ghost ghost temporarily deployed to docs-9045--fixforms August 16, 2021 06:20 Inactive
ciaransweet
ciaransweet previously approved these changes Aug 16, 2021
Copy link

@ciaransweet ciaransweet left a comment

Choose a reason for hiding this comment

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

Nice one @thispsj !

@ghost ghost temporarily deployed to docs-9045--fixforms August 16, 2021 09:26 Inactive
@ghost ghost temporarily deployed to docs-9045--fixforms August 16, 2021 09:46 Inactive
@ghost ghost temporarily deployed to docs-9045--fixforms August 16, 2021 10:27 Inactive
@ghost ghost temporarily deployed to docs-9045--fixforms August 16, 2021 11:27 Inactive
@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Aug 16, 2021
@ramyaparimi
Copy link
Contributor

@thispsj Thanks so much for opening a PR! I got this triaged for review ⚡

guntrip
guntrip previously approved these changes Aug 24, 2021
Copy link
Contributor

@guntrip guntrip left a comment

Choose a reason for hiding this comment

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

This is fantastic, thank you @thispsj! ✨

I've made one little tweak which I'll apply in a second before merging and getting these changes deployed.

Thanks again for taking the time to contribute to our documentation!

@guntrip
Copy link
Contributor

guntrip commented Aug 24, 2021

@thispsj 👋 Would you mind either enabling the checkbox to allow maintainer edits (so I can commit the suggested change above) or committing it yourself? Then I can get this merged in. Thank you!

https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork

@thispsj thispsj dismissed stale reviews from guntrip, ghost , ghost , quasialaw, and ciaransweet via ece3a8f August 24, 2021 13:57
@thispsj
Copy link
Contributor Author

thispsj commented Aug 24, 2021

@stevecat done.

@thispsj thispsj requested a review from guntrip August 24, 2021 13:58
Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com>
@thispsj thispsj requested a review from guntrip August 24, 2021 14:04
@thispsj
Copy link
Contributor Author

thispsj commented Aug 24, 2021

@stevecat you can enable automerge now I guess

Copy link
Contributor

@guntrip guntrip left a comment

Choose a reason for hiding this comment

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

@thispsj Perfect, thanks so much for making those changes! I'll get this merged now ✨

@guntrip guntrip enabled auto-merge August 24, 2021 14:09
@guntrip guntrip merged commit d978edf into github:main Aug 24, 2021
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@thispsj thispsj deleted the fixforms branch August 24, 2021 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Syntax for GitHub's form schema is incorrect with relation to IDs
7 participants