Skip to content

Commit fa3900a

Browse files
davlgddavlgd
committed
chore: update GitHub new issue templates
1 parent f06e46a commit fa3900a

File tree

5 files changed

+191
-26
lines changed

5 files changed

+191
-26
lines changed

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
11
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Community Discussions
4+
url: https://github.com/CleverCloud/Community/discussions
5+
about: Ask questions and discuss with the Clever Cloud community
6+
- name: 🆘 Technical Support
7+
url: https://console.clever-cloud.com/ticket-center-choice
8+
about: Get help with your Clever Cloud applications and services
9+
- name: 📧 Contact Sales & Enterprise
10+
url: https://www.clever-cloud.com/contact/
11+
about: Contact our sales team for business inquiries and enterprise solutions

‎.github/ISSUE_TEMPLATE/content-suggestion.yaml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: 📝 Content and guide suggestion
2+
description: Suggest new documentation content, guides
3+
title: "Content: "
4+
labels: ["documentation", "enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to suggest new content for our documentation!
10+
Your feedback helps us improve and expand our documentation.
11+
12+
- type: checkboxes
13+
id: prerequisites
14+
attributes:
15+
label: "Prerequisites check"
16+
description: "Have you checked if this content already exists?"
17+
options:
18+
- label: I have searched existing [documentation](https://www.clever.cloud/developers/) to verify this content doesn't already exist
19+
- label: I have checked for existing [issues](https://github.com/CleverCloud/documentation/issues) for this request
20+
validations:
21+
required: true
22+
23+
- type: dropdown
24+
id: content-type
25+
attributes:
26+
label: "Type of content requested"
27+
description: "What type of content would you like to see?"
28+
options:
29+
- API
30+
- Documentation
31+
- Guide or tutorial
32+
- Other
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: content-description
38+
attributes:
39+
label: "Content description"
40+
description: "Describe clearly what content should be added"
41+
placeholder: "I would like documentation about... because it would help users to..."
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: use-case
47+
attributes:
48+
label: "Use case and target audience"
49+
description: "Who would benefit from this content and why?"
50+
placeholder: "This would help developers who are trying to... / New users need this when..."
51+
52+
- type: textarea
53+
id: framework-details
54+
attributes:
55+
label: "Technical details (for framework guides)"
56+
description: "If it's a framework guide: name, version, specific challenges, etc."
57+
placeholder: "Framework: Laravel 10, challenges: queue configuration with Redis, special dependencies..."
58+
59+
- type: textarea
60+
id: additional-context
61+
attributes:
62+
label: "Additional context (optional)"
63+
description: "Helpful resources, official documentation, existing examples, etc."
64+
placeholder: "Official docs: https://... Example projects: https://..."

‎.github/ISSUE_TEMPLATE/new-content-form.yaml‎

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/problem-report.yaml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: ⚠️ Report a problem
2+
description: Report an error, technical issue, UX problem, or request clarification
3+
title: "Issue: "
4+
labels: ["documentation", "bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping us improve the quality of our documentation!
10+
11+
**For technical support**, please use [Clever Cloud Support](https://console.clever-cloud.com/ticket-center-choice) instead.
12+
**For general questions**, consider our [Community Discussions](https://github.com/CleverCloud/Community/discussions) first.
13+
14+
- type: dropdown
15+
id: problem-type
16+
attributes:
17+
label: "Type of problem"
18+
description: "What kind of problem are you encountering?"
19+
options:
20+
- Clarification request (unclear or incomplete information)
21+
- Documentation error (incorrect information, broken link, etc.)
22+
- Technical site issue (Hugo build, shortcodes, functionality)
23+
- UX/design problem (accessibility, navigation, responsive)
24+
- Other problem
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: page-urls
30+
attributes:
31+
label: "Affected page(s)"
32+
description: "URLs of the documentation pages with the problem (one per line)"
33+
placeholder: |
34+
https://www.clever.cloud/developers/...
35+
https://www.clever.cloud/developers/...
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: problem-description
41+
attributes:
42+
label: "Problem description"
43+
description: "Describe clearly the problem you encountered"
44+
placeholder: "When I try to... / It's difficult to... / The page doesn't... / The information says... but..."
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: current-content
50+
attributes:
51+
label: "Current problematic content (if applicable)"
52+
description: "Copy the exact text, code, or section that has the issue"
53+
placeholder: "Current text that is incorrect or problematic..."
54+
55+
- type: textarea
56+
id: expected-solution
57+
attributes:
58+
label: "Expected solution or corrected content"
59+
description: "How should this be fixed? What should the information say?"
60+
placeholder: "The correct information should be... / This could be improved by... / The layout should..."
61+
62+
- type: textarea
63+
id: reproduction-steps
64+
attributes:
65+
label: "Steps to reproduce (if applicable)"
66+
description: "For technical issues: how to reproduce the problem"
67+
placeholder: |
68+
1. Run `hugo server`
69+
2. Navigate to...
70+
3. See error
71+
72+
- type: textarea
73+
id: additional-context
74+
attributes:
75+
label: "Additional context"
76+
description: "Screenshots, error messages, browser, device, etc."
77+
placeholder: "Browser: Chrome on mobile, console errors, screenshots, etc."

‎.github/ISSUE_TEMPLATE/zzz-other.yaml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: ❓ Other request
2+
description: For requests that don't fit into other categories
3+
title: "Other: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this template for requests that don't fit into our other categories.
10+
11+
**Before using this template**, please check if your request fits better in:
12+
- 📝 Content and guide suggestion (new content, framework guides)
13+
- ⚠️ Report a problem (errors, bugs, UX issues, clarifications)
14+
15+
- type: checkboxes
16+
id: other-prerequisites
17+
attributes:
18+
label: "Prerequisites check"
19+
description: "Have you checked the appropriate resources?"
20+
options:
21+
- label: I have checked that this request doesn't fit into other issue templates
22+
- label: I have searched for existing [issues](https://github.com/CleverCloud/documentation/issues)
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: issue-description
28+
attributes:
29+
label: "Describe your request"
30+
description: "Please provide a clear description of what you need"
31+
placeholder: "I have a request for... / I would like to... / I noticed that..."
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: context-details
37+
attributes:
38+
label: "Additional context"
39+
description: "Any additional information that might help us understand your request"
40+
placeholder: "Related pages, external links, specific examples, etc."

0 commit comments

Comments
 (0)