New Slack and wording improvements in templates

This commit is contained in:
Christian Mäder 2021-03-04 09:59:05 +01:00
parent ad0c04985b
commit 0125ab4849
4 changed files with 77 additions and 40 deletions

View File

@ -1,6 +1,6 @@
--- ---
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a report about a malfunction of the Docker setup
title: '' title: ''
labels: '' labels: ''
assignees: '' assignees: ''
@ -9,39 +9,49 @@ assignees: ''
<!-- <!--
Before raising an issue here, answer the following questions for yourself, please: Please only raise an issue if you're certain that you've found a bug.
Else, see these other means to get help:
* Did you read through the troubleshooting section? (https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting) * See our troubleshooting section:
* Have you had a look at the rest of the wiki? (https://github.com/netbox-community/netbox-docker/wiki) https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
* Have you updated to the latest version and tried again? (i.e. `git pull` and `docker-compose pull`) * Have a look at the rest of the wiki:
* Have you reset the project and tried again? (i.e. `docker-compose down -v`) https://github.com/netbox-community/netbox-docker/wiki
* Are you confident that your problem is related to the Docker image or Docker Compose file this project provides? * Check the release notes:
(Otherwise ask on the NetBox mailing list, please: https://groups.google.com/d/forum/netbox-discuss) https://github.com/netbox-community/netbox-docker/releases
* Have you looked through the issues already resolved? * Look through the issues already resolved:
https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
Please try this means to get help before opening an issue here: If you did not find what you're looking for,
try the help of our community:
* On the networktocode Slack in the #netbox-docker channel: http://slack.networktocode.com/ * Post to Github Discussions:
* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/ https://github.com/netbox-community/netbox-docker/discussions
* On the NetBox mailing list: https://groups.google.com/d/forum/netbox-discuss * Join the `#netbox-docker` channel on our Slack:
https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
* Ask on the NetBox mailing list:
https://groups.google.com/d/forum/netbox-discuss
Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough. Please don't open an issue to open a PR.
Just submit the PR, that's good enough.
--> -->
## Current Behavior ## Current Behavior
<!-- describe what you did and how it misbehaved --> <!-- describe what you did and how it misbehaved -->
...
## Expected Behavior ## Expected Behavior
<!-- describe what you expected instead --> <!-- describe what you expected instead -->
...
## Debug Information ## Debug Information
<!-- please fill in the following information that might helps us debug your problem more quickly --> <!-- please fill in the following information that helps us debug your problem more quickly -->
The output of `docker-compose version`: `XXXXX` The output of `docker-compose version`: `XXXXX`
The output of `docker version`: `XXXXX` The output of `docker version`: `XXXXX`
The output of `git rev-parse HEAD`: `XXXXX` The output of `git rev-parse HEAD`: `XXXXX`
@ -59,7 +69,16 @@ The output of `docker inspect netboxcommunity/netbox:latest --format "{{json .Co
The output of `docker-compose logs netbox`: The output of `docker-compose logs netbox`:
<!-- <!--
If your log is very long, create a Gist instead (and post the link to it): https://gist.github.com If your log is very long, create a Gist instead and post the link to it: https://gist.github.com
-->
```text
LOG LOG LOG
```
The output of `cat docker-compose.override.yml`:
<!--
If this file is very long, create a Gist instead and post the link to it: https://gist.github.com
--> -->
```text ```text

View File

@ -5,7 +5,7 @@ contact_links:
about: The Github Discussions are the right place to ask questions about how to use or do certain things with NetBox Docker. about: The Github Discussions are the right place to ask questions about how to use or do certain things with NetBox Docker.
- name: Chat - name: Chat
url: http://slack.networktocode.com/ url: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
about: 'Usually the quickest way to seek help with small issues is to join our #netbox-docker Slack channel.' about: 'Usually the quickest way to seek help with small issues is to join our #netbox-docker Slack channel.'
- name: Community Wiki - name: Community Wiki

View File

@ -9,39 +9,52 @@ assignees: ''
<!-- <!--
Before raising an issue here, answer the following questions for yourself, please: This issue type is to propose new features for the Docker setup.
To just spin an idea, see the Github Discussions section, please.
* Did you read through the troubleshooting section? (https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting) Before asking for help, see these links first:
* Have you had a look at the rest of the wiki? (https://github.com/netbox-community/netbox-docker/wiki)
* Have you read the release notes recently (https://github.com/netbox-community/netbox-docker/releases)
* Are you confident that your feature/change request is related to the Docker image or Docker Compose file this project provides?
(Otherwise ask on the NetBox mailing list, please: https://groups.google.com/d/forum/netbox-discuss)
* Have you looked through the issues already resolved?
Please try this means to get help before opening an issue here: * See our troubleshooting section:
https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
* Have a look at the rest of the wiki:
https://github.com/netbox-community/netbox-docker/wiki
* Check the release notes:
https://github.com/netbox-community/netbox-docker/releases
* Look through the issues already resolved:
https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
* On the networktocode Slack in the #netbox-docker channel: http://slack.networktocode.com/ If you did not find what you're looking for,
* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/ try the help of our community:
* On the NetBox mailing list: https://groups.google.com/d/forum/netbox-discuss
Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough. * Post to Github Discussions:
https://github.com/netbox-community/netbox-docker/discussions
* Join the `#netbox-docker` channel on our Slack:
https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
* Ask on the NetBox mailing list:
https://groups.google.com/d/forum/netbox-discuss
Please don't open an issue to open a PR.
Just submit the PR, that's good enough.
--> -->
## Desired Behavior ## Desired Behavior
<!-- please describe the behavior you desire --> <!-- please describe the behavior you desire -->
...
## Contrast to Current Behavior ## Contrast to Current Behavior
<!-- please describe how the desired behavior is different from the current behavior --> <!-- please describe how the desired behavior is different from the current behavior -->
...
## Changes Required ## Changes Required
<!-- if you can, please elaborate what changes would exactly be required --> <!-- if you can, please elaborate what changes would exactly be required -->
...
## Discussion: Benefits and Drawbacks ## Discussion: Benefits and Drawbacks
@ -51,4 +64,5 @@ Please make your case here:
- What are the drawbacks of this change? Is it backwards-compatible? - What are the drawbacks of this change? Is it backwards-compatible?
- Anything else that you think is relevant to the discussion of this feature/change request. - Anything else that you think is relevant to the discussion of this feature/change request.
--> -->
...

View File

@ -11,15 +11,17 @@
Images are built using this code and are released to [Docker Hub][netbox-dockerhub] and [Quay.io][netbox-quayio] once a day. Images are built using this code and are released to [Docker Hub][netbox-dockerhub] and [Quay.io][netbox-quayio] once a day.
Do you have any questions? Do you have any questions?
Before opening an issue on Github, please join the [Network To Code][ntc-slack] Slack and ask for help in our [`#netbox-docker`][netbox-docker-slack] channel. Before opening an issue on Github,
please join the [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-docker`][netbox-docker-slack-channel] channel.
[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers [github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
[github-release]: https://github.com/netbox-community/netbox-docker/releases [github-release]: https://github.com/netbox-community/netbox-docker/releases
[netbox-docker-microbadger]: https://microbadger.com/images/netboxcommunity/netbox [netbox-docker-microbadger]: https://microbadger.com/images/netboxcommunity/netbox
[netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/ [netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/
[netbox-docker-github]: https://github.com/netbox-community/netbox-docker/ [netbox-docker-github]: https://github.com/netbox-community/netbox-docker/
[ntc-slack]: http://slack.networktocode.com/ [netbox-docker-slack]: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
[netbox-docker-slack]: https://slack.com/app_redirect?channel=netbox-docker&team=T09LQ7E9E [netbox-docker-slack-channel]: https://netdev-community.slack.com/archives/C01P0GEVBU7
[netbox-slack-channel]: https://netdev-community.slack.com/archives/C01P0FRSXRV
[netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE [netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE
[netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox [netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox
@ -84,10 +86,12 @@ It covers advanced topics such as using files for secrets, deployment to Kuberne
## Getting Help ## Getting Help
Feel free to ask questions in our [Github Community][netbox-community] or join [our Slack channel `#netbox-docker`][netbox-docker-slack] on the [Network To Code Slack][ntc-slack], Feel free to ask questions in our [Github Community][netbox-community]
or [join our Slack][netbox-docker-slack] and ask [in our channel `#netbox-docker`][netbox-docker-slack-channel],
which is free to use and where there are almost always people online that can help you in the Slack channel. which is free to use and where there are almost always people online that can help you in the Slack channel.
If you need help with using NetBox or developing for it or against it's API you may find the `#netbox` channel on the same Slack instance very helpful. If you need help with using NetBox or developing for it or against it's API
you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack instance very helpful.
[netbox-community]: https://github.com/netbox-community/netbox-docker/discussions [netbox-community]: https://github.com/netbox-community/netbox-docker/discussions