Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: revise the sentence in second bullet #380

Merged
merged 9 commits into from
Aug 16, 2023
Merged

fix: revise the sentence in second bullet #380

Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4448b90
fix: revise the sentence in second bullet
CBID2 Aug 4, 2023
eb6ca27
fix: change line 61
CBID2 Aug 14, 2023
fefb5c1
fix: changed introductory phrase back
CBID2 Aug 14, 2023
53d7311
fix: omit line
CBID2 Aug 14, 2023
fa4741b
feat: add example of rule
CBID2 Aug 15, 2023
823b129
fix: remove my example
CBID2 Aug 15, 2023
0f75a14
fix: revise formatting
CBID2 Aug 15, 2023
27f45ad
fix: revise format
CBID2 Aug 15, 2023
82e7e86
Removed excess text
bergerhoffer Aug 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion supplementary_style_guide/style_guidelines/links.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An example would be helpful.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done @mportman12

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mportman12 we already do show an example below. The "Article title" one covers this already.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I revert the commit I made for that @bergerhoffer?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done @bergerhoffer

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made the changes @bergerhoffer

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I got it this time @bergerhoffer


* When the link appears in *Additional resources*, put the article title first, followed by `(Red Hat Knowledgebase)`.


Expand Down