Skip to content

Commit 1da1853

Browse files
committed
Point people towards GitHub Discussions for questions / support
1 parent 7e5eedf commit 1da1853

File tree

4 files changed

+21
-22
lines changed

4 files changed

+21
-22
lines changed

.github/ISSUE_TEMPLATE/QUESTION.md

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

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "❓ Question"
4+
url: https://github.com/torchbox/django-pattern-library/discussions
5+
about: Use GitHub Discussions to get help with this project.

docs/community/support.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Help and support
2+
3+
If you need help with this project, here are things you should try.
4+
5+
## Documentation search
6+
7+
We take good care to document common use cases of the library, with examples and code snippets. We also document use cases that are known to not be well supported, with links to issues.
8+
9+
## GitHub search
10+
11+
GitHub’s [main search](https://github.com/torchbox/django-pattern-library/search?q=help) can find matches in existing issues, pull requests, and discussions. The [cs.github.com code search](https://cs.github.com/torchbox/django-pattern-library?q=help) is excellent to search within the repository.
12+
13+
## GitHub Discussions
14+
15+
No luck with the existing documentation and other search results? Open a new discussion in [GitHub Discussions](https://github.com/torchbox/django-pattern-library/discussions) for conversations relating to the project. This can be used for support requests, or high-level feature ideas that don’t fit well with our issue template.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ nav:
5555
- 'Concepts': 'reference/concepts.md'
5656
- 'Known issues': 'reference/known-issues.md'
5757
- 'Community':
58+
- 'Support': 'community/support.md'
5859
- 'Related projects': 'community/related-projects.md'
5960
- 'Code of conduct': 'community/code-of-conduct.md'
6061
- 'Security policy': 'community/security-policy.md'

0 commit comments

Comments
 (0)