fix: revise the sentence in second bullet #380
Conversation
| @@ -8,7 +8,7 @@ | |||
| Follow these guidelines when adding cross-references within your documentation: | |||
|
|
|||
| * Include cross-references only when necessary. | |||
| * If the information is critical, consider including it instead of cross-referencing. | |||
| * When not using running text,, consider including it instead of cross-referencing. | |||
There was a problem hiding this comment.
So the line to modify for this one was line 61, if you can make the adjustment there instead
| @@ -58,7 +58,8 @@ Follow these guidelines when specifying link text: | |||
| == Links to Red Hat Knowledgebase articles | |||
|
|
|||
| * Use the title of the Knowledgebase article for the link text, or use descriptive running text. | |||
| * Call out that this is a Knowledgebase article when _not_ using running text. | |||
| * When not using running text, call out that this is a Knowledgebase article. | |||
| when _not_ using running text. | |||
There was a problem hiding this comment.
This line needs to be removed
| @@ -58,7 +58,8 @@ Follow these guidelines when specifying link text: | |||
| == Links to Red Hat Knowledgebase articles | |||
|
|
|||
| * Use the title of the Knowledgebase article for the link text, or use descriptive running text. | |||
| * Call out that this is a Knowledgebase article when _not_ using running text. | |||
| * When not using running text, call out that this is a Knowledgebase article. | |||
There was a problem hiding this comment.
An example would be helpful.
There was a problem hiding this comment.
@mportman12 we already do show an example below. The "Article title" one covers this already.
There was a problem hiding this comment.
Should I revert the commit I made for that @bergerhoffer?
There was a problem hiding this comment.
I think so, unless @mportman12 has any objections or something else that we do need to address. The intent of this update was just to fix the sentence order, per Breda's issue list.
There was a problem hiding this comment.
@CBID2 when I look at the diff (https://github.com/redhat-documentation/supplementary-style-guide/pull/380/files), it looks like you removed the good, if you can make that change back:
* When not using running text, call out that this is a Knowledgebase article.
And then there are still some extra lies (62 and 67) that you had added that need to be removed still. Thanks!
There was a problem hiding this comment.
Made the changes @bergerhoffer
There was a problem hiding this comment.
@CBID2 please check the diff after your update: https://github.com/redhat-documentation/supplementary-style-guide/pull/380/files
The only change should be to line 61, not the extra lines that were added
There was a problem hiding this comment.
I think I got it this time @bergerhoffer
|
@mportman12, all we need is your approval and then merge time! 😊 |
|
@julian-cable, can you approve of this PR please? |
|
@CBID2 This PR would be for a different style guide that the Red Hat Documentation team uses; I am not part of that team, so I don't think I am qualified to give such an approval. |
|
lgtm |
|
Approved and merged. |
|
Great job everyone! 😊 |
Changes made
This PR rephrases part of the sentence displayed via the second bullet in the links subsection of the guide.
Issue
Closes #147
Note to Reviewers
Hi @bergerhoffer! :) Here's the new PR! :)