Skip to content

issue templates: remove preview_only attribute - #16550

Merged
janiceilene merged 6 commits into
github:mainfrom
timdeschryver:patch-2
May 25, 2022
Merged

issue templates: remove preview_only attribute#16550
janiceilene merged 6 commits into
github:mainfrom
timdeschryver:patch-2

Conversation

@timdeschryver

@timdeschryvertimdeschryver commented Mar 26, 2022

Copy link
Copy Markdown
Contributor

Why:

Closes [issue link]

Hi, first of all thank you for the template feature, it's a great improvement!

When I tried it out earlier, I encountered a problem with the examples that include a preview_only attribute. It seems like that attribute doesn't exist, resulting in a badly formatted template when we copy paste the snippet.

I also couldn't find more information about the property, for example in https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema, so I assume that this property can be removed from the examples.

Here, you can see an example, in which I added the preview_only attribute to our template https://github.com/ngrx/platform/blob/a812382d4a0b60c97f5141053a31d5880c0159c2/.github/ISSUE_TEMPLATE/bug-report.yml

image

What's being changed:

The preview_only attribute is removed from the examples.

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@welcome

welcomeBot commented Mar 26, 2022

Copy link
Copy Markdown

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actionsgithub-actionsBot added the triage Do not begin working on this issue until triaged by the team label Mar 26, 2022
@github-actions

github-actionsBot commented Mar 26, 2022

Copy link
Copy Markdown
Contributor

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

SourcePreviewProductionWhat Changed
communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.mdfpt
ghec
fpt
ghec

@ramyaparimiramyaparimi 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 communities Content related to Communities and removed triage Do not begin working on this issue until triaged by the team labels Mar 28, 2022
@ramyaparimi

Copy link
Copy Markdown
Contributor

@timdeschryver
Thanks so much for opening a PR! I'll get this triaged for review ⚡

@janiceilenejaniceilene left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks so much for opening this PR @timdeschryver! I checked with the team and it sounds like preview_only was removed a while back, but the change never made it to the docs 😅 so we really appreciate you catching that 💖

I'll update the branch and get this merged soon ⚡

@janiceilenejaniceilene added the ready to merge This pull request is ready to merge label May 23, 2022
@janiceilene
janiceilene merged commit c9f313e into github:mainMay 25, 2022
@github-actions

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

@timdeschryver
timdeschryver deleted the patch-2 branch May 25, 2022 19:57
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

communitiesContent related to CommunitiescontentThis issue or pull request belongs to the Docs Content teamready to mergeThis pull request is ready to mergewaiting for reviewIssue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@timdeschryver@ramyaparimi@janiceilene@docubot