From 0125ab4849b3605f382d6381b61d904eee20e5d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Ma=CC=88der?= Date: Thu, 4 Mar 2021 09:59:05 +0100 Subject: [PATCH] New Slack and wording improvements in templates --- .github/ISSUE_TEMPLATE/bug_report.md | 55 +++++++++++++++-------- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 46 ++++++++++++------- README.md | 14 +++--- 4 files changed, 77 insertions(+), 40 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e11e37f..f386e8c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a report about a malfunction of the Docker setup title: '' labels: '' assignees: '' @@ -9,39 +9,49 @@ assignees: '' ## Current Behavior -... + + ## Expected Behavior -... + + ## Debug Information - + + The output of `docker-compose version`: `XXXXX` The output of `docker version`: `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`: + +```text +LOG LOG LOG +``` + +The output of `cat docker-compose.override.yml`: + ```text diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index fe9f090..a584cc2 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. - 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.' - name: Community Wiki diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c9acfcf..38bba42 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -9,39 +9,52 @@ assignees: '' ## Desired Behavior -... + + ## Contrast to Current Behavior -... + + ## Changes Required -... + + ## Discussion: Benefits and Drawbacks @@ -51,4 +64,5 @@ Please make your case here: - 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. --> -... + + diff --git a/README.md b/README.md index 8458fea..fa0c9bd 100644 --- a/README.md +++ b/README.md @@ -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. 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-release]: https://github.com/netbox-community/netbox-docker/releases [netbox-docker-microbadger]: https://microbadger.com/images/netboxcommunity/netbox [netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/ [netbox-docker-github]: https://github.com/netbox-community/netbox-docker/ -[ntc-slack]: http://slack.networktocode.com/ -[netbox-docker-slack]: https://slack.com/app_redirect?channel=netbox-docker&team=T09LQ7E9E +[netbox-docker-slack]: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ +[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-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 -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. -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