From e0dbaf9cc20f6b39b8da8626e3dacecd8c534942 Mon Sep 17 00:00:00 2001 From: BK Date: Thu, 19 May 2022 18:34:16 +1000 Subject: [PATCH 1/2] fix: deprecate references to discourse As per the maintainer's directive, there were some issues with discourse. Github Dicussions seem to be preferred as per https://github.com/shrinerb/shrine/discussions/578 The documentation and links have accordingly been updated, but some links to discourse are still retained for historical purposes. --- .github/ISSUE_TEMPLATE.md | 2 +- CONTRIBUTING.md | 3 ++- README.md | 1 + SELF_CONTAINED_EXAMPLE.md | 1 + website/core/Footer.js | 12 +++++++++--- website/i18n/en.json | 2 +- website/siteConfig.js | 3 ++- 7 files changed, 17 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index af3a629ee..435ff6ebf 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,5 +1,5 @@ - Issues are for bug reports only. -- Have a question or unsure if it's a bug, then please inquire on the [forum](https://discourse.shrinerb.com). +- Have a question or unsure if it's a bug, then please inquire on [Github Discussions](https://github.com/shrinerb/shrine/discussions) or on the [forum](https://discourse.shrinerb.com). --- ### Brief Description diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c7fc7f3c..5df00d679 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Issue Guidelines ================ 1. Issues should only be created for things that are definitely bugs. If you - are not sure that the behavior is a bug, ask about it on the [forum]. Otherwise Github gets overwhelmed with issues and it is very difficult for the maintainers to manage. + are not sure that the behavior is a bug, ask about it on the [forum] or on [Github Discussions]. Otherwise Github gets overwhelmed with issues and it is very difficult for the maintainers to manage. 2. If you are sure it is a bug, then post a complete description of the issue, the simplest possible [self-contained example] showing the problem (please do review the link), and the full backtrace of any exception. @@ -59,6 +59,7 @@ Code of Conduct Everyone interacting in the Shrine project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [Shrine code of conduct]. +[Github Discussions]: https://github.com/shrinerb/shrine/discussions [forum]: https://discourse.shrinerb.com [Shrine code of conduct]: https://github.com/shrinerb/shrine/blob/master/CODE_OF_CONDUCT.md [libmagic]: https://github.com/threatstack/libmagic diff --git a/README.md b/README.md index 722d28090..934bbd637 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ guide]**. | Website & Documentation | [shrinerb.com](https://shrinerb.com) | | Demo code | [Roda][roda demo] / [Rails][rails demo] | | Wiki | [github.com/shrinerb/shrine/wiki](https://github.com/shrinerb/shrine/wiki) | +| Help (Preferred) | [Github Discussions](https://github.com/shrinerb/shrine/discussions) | | Help & Discussion | [discourse.shrinerb.com](https://discourse.shrinerb.com) | ## Setup diff --git a/SELF_CONTAINED_EXAMPLE.md b/SELF_CONTAINED_EXAMPLE.md index d29c405ef..cb0132e93 100644 --- a/SELF_CONTAINED_EXAMPLE.md +++ b/SELF_CONTAINED_EXAMPLE.md @@ -148,6 +148,7 @@ If you would like to debug or step through Shrine's code using the above templat 8. Run `ruby template_name.rb`. +[Github Discussions]: https://github.com/shrinerb/shrine/discussions [forum]: https://discourse.shrinerb.com [Shrine code of conduct]: https://github.com/shrinerb/shrine/blob/master/CODE_OF_CONDUCT.md [libmagic]: https://github.com/threatstack/libmagic diff --git a/website/core/Footer.js b/website/core/Footer.js index bb2aa57de..1aabfbdcf 100755 --- a/website/core/Footer.js +++ b/website/core/Footer.js @@ -31,12 +31,12 @@ class Footer extends React.Component { Contributing
-
Community
+
Help
- Discourse + Github Discussions Stack Overflow + + Discourse +
More
diff --git a/website/i18n/en.json b/website/i18n/en.json index dea953b10..a57dc4460 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -364,7 +364,7 @@ "Guides": "Guides", "Plugins": "Plugins", "External": "External", - "Discourse": "Discourse", + "Help": "Help", "GitHub": "GitHub", "Wiki": "Wiki" }, diff --git a/website/siteConfig.js b/website/siteConfig.js index ef620752f..0c925789c 100644 --- a/website/siteConfig.js +++ b/website/siteConfig.js @@ -35,7 +35,7 @@ const siteConfig = { {doc: 'getting-started', label: 'Guides'}, {doc: 'plugins/activerecord', label: 'Plugins'}, {doc: 'external/extensions', label: 'External'}, - {href: 'https://discourse.shrinerb.com', label: 'Discourse', external: true}, + {href: 'https://github.com/shrinerb/shrine/discussions', label: 'Help', external: true}, {href: 'https://github.com/shrinerb/shrine', label: 'GitHub', external: true}, {href: 'https://github.com/shrinerb/shrine/wiki', label: 'Wiki', external: true}, ], @@ -109,6 +109,7 @@ const siteConfig = { editUrl: 'https://github.com/shrinerb/shrine/edit/master/doc/', blogUrl: 'https://janko.io', discourseUrl: 'https://discourse.shrinerb.com', + githubDiscussionsUrl: 'https://github.com/shrinerb/shrine/discussions', stackOverflowUrl: 'https://stackoverflow.com/questions/tagged/shrine', twitterUsername: 'shrine_rb', From 708971d9cfef3fd22dd1c2eeedb9c1d1c8492c1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janko=20Marohni=C4=87?= Date: Thu, 6 Oct 2022 19:44:17 +0200 Subject: [PATCH 2/2] Remove added ISSUE_TEMPLATE.md --- .github/ISSUE_TEMPLATE.md | 20 -------------------- 1 file changed, 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 435ff6ebf..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,20 +0,0 @@ -- Issues are for bug reports only. -- Have a question or unsure if it's a bug, then please inquire on [Github Discussions](https://github.com/shrinerb/shrine/discussions) or on the [forum](https://discourse.shrinerb.com). ---- - -### Brief Description -Write a brief description of the issue. - -### Expected behavior -Tell us what you expected to happen. - -### Actual behavior -Tell us what happens instead. - -### Simplest self-contained example code to demonstrate issue -Provide a self-contained example code (see the [Sequel/ActiveRecord templates](https://github.com/shrinerb/shrine/blob/master/CONTRIBUTING.md)) to show the problem, and the full backtrace of any exception. - -### System configuration -**Ruby version**: - -**Shrine version**: