Remove inconsistencies about getting help #396
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We references to the unofficial Exercism help channels on Gitter with references to the new official Exercism forum. In a couple of places this introduced inconsistencies. The first is a sample `help.md` file, where instead of linking to the Gitter channel we referenced a language- specific sub-channel on the forum. However this was in a document where we discourage links to Exercism-wide resources, which will already be included in the docs seen by the end-user. The second is the name of a markdown link-reference. We were linking to the Building Exercism sub-channel, but called the link-reference 'forum'. Elsewhere, 'forum' links to the top-level forum, and we've called the reference 'building-exercism' when linking to this category. This fixes these inconsistencies.
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
This normalizes the reference to the Building Exercism subcategory on the forum in markdown reference links.
ee7
approved these changes
Oct 25, 2022
ErikSchierboom
pushed a commit
to ErikSchierboom/docs
that referenced
this pull request
Nov 22, 2022
* Remove inconsistencies about getting help We references to the unofficial Exercism help channels on Gitter with references to the new official Exercism forum. In a couple of places this introduced inconsistencies. The first is a sample `help.md` file, where instead of linking to the Gitter channel we referenced a language- specific sub-channel on the forum. However this was in a document where we discourage links to Exercism-wide resources, which will already be included in the docs seen by the end-user. The second is the name of a markdown link-reference. We were linking to the Building Exercism sub-channel, but called the link-reference 'forum'. Elsewhere, 'forum' links to the top-level forum, and we've called the reference 'building-exercism' when linking to this category. This fixes these inconsistencies. * Use subreddit instead of channel in help doc example Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com> * Use https in help doc example Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com> * Normalize forum reference This normalizes the reference to the Building Exercism subcategory on the forum in markdown reference links. Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We references to the unofficial Exercism help channels on
Gitter with references to the new official Exercism forum.
In a couple of places this introduced inconsistencies.
The first is a sample
help.mdfile, where instead oflinking to the Gitter channel we referenced a language-
specific sub-channel on the forum. However this was in
a document where we discourage links to Exercism-wide
resources, which will already be included in the docs
seen by the end-user.
The second is the name of a markdown link-reference.
We were linking to the Building Exercism sub-channel,
but called the link-reference 'forum'. Elsewhere,
'forum' links to the top-level forum, and we've called
the reference 'building-exercism' when linking to
this category.
This fixes these inconsistencies.
With thanks to @ee7 for suggesting the improvements in #395