Skip to content

Commit 2a48af4

Browse files
authored
Merge pull request #509 from bergerhoffer/github-490
GitHub-490: Adding a link to the IBM Style guide
2 parents 34fb798 + 895d778 commit 2a48af4

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

supplementary_style_guide/introduction/about-guide.adoc

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
= About this guide
22

3-
The style and language guidance in this guide overrides or supplements some guidance provided by the _IBM Style_ guide, which is the primary source of style guidance for link:https://www.redhat.com/[Red{nbsp}Hat] product and cross-product solution documentation.
3+
The style and language guidance in this guide overrides or supplements some guidance provided by the link:https://www.ibm.com/docs/en/ibm-style[_IBM Style_] guide, which is the primary source of style guidance for link:https://www.redhat.com/[Red{nbsp}Hat] product and cross-product solution documentation.
44

5-
The Red{nbsp}Hat Customer Content Services team has created this guide to help ensure that Red{nbsp}Hat product documentation is clear, consistent, and cohesive. Upstream communities who want to align more closely with the standards used by Red{nbsp}Hat product documentation can also use this guide.
5+
The Red{nbsp}Hat Customer Content Services team has created this guide to help ensure that Red{nbsp}Hat product documentation is clear, consistent, and cohesive. Upstream communities who want to align more closely with the standards used by Red{nbsp}Hat product documentation can also use this guide. However, some links in this guide might not be accessible for non-Red Hat associates.
66

77
[NOTE]
88
====
@@ -13,7 +13,13 @@ Other Red{nbsp}Hat technical documentation, including Red{nbsp}Hat training and
1313

1414
Red{nbsp}Hat product documentation adheres to the style guidance provided in the _IBM Style_ guide, the _Red{nbsp}Hat supplementary style guide for product documentation_, and documentation style guidelines specific to Red{nbsp}Hat products, such as Red{nbsp}Hat Enterprise Linux or Red{nbsp}Hat OpenShift Container Platform.
1515

16-
When seeking style guidance, consult the style guide specific to your product documentation project first, if applicable, then the _Red{nbsp}Hat supplementary style guide for product documentation_, and finally the _IBM Style_ guide.
16+
When seeking style guidance, consult the style guide specific to your product documentation project first, if applicable, then the link:https://redhat-documentation.github.io/supplementary-style-guide[_Red{nbsp}Hat supplementary style guide for product documentation_], and finally the link:https://www.ibm.com/docs/en/ibm-style[_IBM Style_] guide.
17+
18+
[NOTE]
19+
====
20+
To log in to the _IBM Style_ guide, enter your Red{nbsp}Hat email address in the *IBMid* field.
21+
====
22+
1723
The following image illustrates the hierarchical relationship between the different style guides in Red{nbsp}Hat product documentation:
1824

1925
image:images/ccs-style-guide-hierarchy.png[CCS style guide hierarchy]

supplementary_style_guide/main.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ include::introduction/contributing.adoc[leveloffset=+2]
1818
[[style-guidelines]]
1919
== Style guidelines
2020

21-
These recommendations might override existing guidance in the _IBM Style_ guide, or might provide guidance for items not covered in the _IBM Style_ guide.
21+
These recommendations might override existing guidance in the link:https://www.ibm.com/docs/en/ibm-style[_IBM Style_] guide, or might provide guidance for items not covered in the _IBM Style_ guide.
2222

2323
[NOTE]
2424
====

0 commit comments

Comments
 (0)