Skip to content

Commit

Permalink
Enable new Open Source feedback control (#4640)
Browse files Browse the repository at this point in the history
1. Create new YML based templates, removing the old markdown based template.
1. Add the issue-template config file.
1. Update docfx.json to match the new templates.
  • Loading branch information
BillWagner authored Feb 5, 2024
1 parent 33a59c2 commit 784bf73
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 4 deletions.
3 changes: 0 additions & 3 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/a-general-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: "General feedback"
description: Provide general feedback about the Entity Framework docs or a specific article.
body:
- type: markdown
attributes:
value: "Describe the issue or suggestion. NOTE: If your issue is about a specific article, it's best to submit your feedback by clicking the 'Open a documentation issue' link in the 'EntityFramework feedback' box at the end of the article."
- type: input
id: topic
attributes:
label: Issue or suggestion
description: Describe the issue
validations:
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Entity Framework product feedback
url: https://github.com/dotnet/efcore/issues
about: Log Entity Framework product feedback here
- name: learn.microsoft.com site feedback
url: https://github.com/MicrosoftDocs/feedback/issues/new/choose
about: Log general learn.microsoft.com site issues here
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/z-customer-feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Learn feedback control.
description: |
⛔ This template is hooked into the feedback control on the bottom of every page on the live site. It automatically fills in several fields for you. Don't use for other purposes. ⛔
body:
- type: markdown
attributes:
value: "## Issue information"
- type: markdown
attributes:
value: Select the issue type, and describe the issue in the text box below. Add as much detail as needed to help us resolve the issue.
- type: dropdown
id: issue-type
attributes:
label: Type of issue
options:
- Typo
- Code doesn't work
- Missing information
- Outdated article
- Other (describe below)
validations:
required: true
- type: textarea
id: feedback
validations:
required: true
attributes:
label: Description
- type: markdown
attributes:
value: "## 🚧 Article information 🚧"
- type: markdown
attributes:
value: "*Don't modify the following fields*. They are automatically filled in for you. Doing so will disconnect your issue from the affected article. *Don't edit them*."
- type: input
id: pageUrl
validations:
required: true
attributes:
label: Page URL
- type: input
id: contentSourceUrl
validations:
required: true
attributes:
label: Content source URL
- type: input
id: documentVersionIndependentId
validations:
required: true
attributes:
label: Document Version Independent Id
- type: input
id: author
validations:
required: true
attributes:
label: Article author
8 changes: 7 additions & 1 deletion entity-framework/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,15 @@
"ms.tgt_pltfrm": "dotnet",
"ms.devlang": "dotnet",
"ms.author": "avickers",
"feedback_system": "GitHub",
"feedback_system": "OpenSource",
"feedback_github_repo": "dotnet/EntityFramework.Docs",
"feedback_product_url": "https://github.com/dotnet/efcore/issues/new/choose",
"open_source_feedback_contributorGuideUrl": "https://learn.microsoft.com/contribute/content/dotnet/dotnet-contribute",
"open_source_feedback_issueTitle": "",
"open_source_feedback_productLogoLightUrl": "https://learn.microsoft.com/media/logos/logo_net.svg",
"open_source_feedback_productLogoDarkUrl": "https://learn.microsoft.com/media/logos/logo_net.svg",
"open_source_feedback_issueUrl": "https://github.com/dotnet/EntityFramework.Docs/issues/new?template=z-customer-feedback.yml",
"open_source_feedback_productName": ".NET",
"uhfHeaderId": "MSDocsHeader-DotNet"
},
"fileMetadata": {
Expand Down

0 comments on commit 784bf73

Please sign in to comment.