[Issue template] Provide better guidance and redirection when opening an issue (#500)
* providing better guidance and redirection when using an issue * using great feedback from @Haroenv
This commit is contained in:
parent
b0984ccc63
commit
43d1ceb45b
2 changed files with 28 additions and 2 deletions
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
name: Enhance the search-UI
|
||||
about: Everything related to the front end library
|
||||
---
|
||||
|
||||
<!--
|
||||
Thanks for participating in this project!
|
||||
Please:
|
||||
|
|
@ -5,12 +10,16 @@
|
|||
- do at least one GitHub search in current issues, maybe your question is already here
|
||||
-->
|
||||
|
||||
**Do you want to request a *feature* or report a *bug*?**
|
||||
**Do you want to request a _feature_ or report a _bug_?**
|
||||
|
||||
**What is the current behavior?**
|
||||
|
||||
**If the current behavior is a bug, please provide all the steps to reproduce and a minimal
|
||||
[JSFiddle](https://jsfiddle.net/) example or a repository on GitHub that we can `npm install`
|
||||
[JSFiddle][3] example or a repository on GitHub that we can `npm install`
|
||||
and `npm start`.**
|
||||
|
||||
**What is the expected behavior?**
|
||||
|
||||
[1]: https://github.com/algolia/docsearch-configs
|
||||
[2]: https://community.algolia.com/docsearch/config-file.html
|
||||
[3]: (https://jsfiddle.net/)
|
||||
17
.github/ISSUE_TEMPLATE/docsearch_user.md
vendored
Normal file
17
.github/ISSUE_TEMPLATE/docsearch_user.md
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
name: Issue with your own DocSearch implementation
|
||||
about: Everything related to your own custom DocSearch index having a configuration
|
||||
---
|
||||
|
||||
**Is your issue related to your own DocSearch implementation?**
|
||||
|
||||
- If it is a styling issue regarding your search-UI, you are in the good place, you can remove this section.
|
||||
- If the issue is due to a wrong individual crawl:
|
||||
|
||||
Please [try to update your configuration][1]. Our [dedicated documentation welcomes any feedback][2]. If it is not solving it, please open an issue on the configuration repository.
|
||||
|
||||
If you are using our DocSearch on your own, please note that we will help you in the best effort possible.
|
||||
|
||||
- What is the dropdown version you are using?
|
||||
- What is the scraper version you are using?
|
||||
- Could you share us the configuration file you are using?
|
||||
Loading…
Reference in a new issue