You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix xref guidelines for contrib doc, make 1 scenario
Fix xref guidelines for contrib doc, make 1 scenario
openshiftGH-53958: Fix xref guidelines for contrib doc
As called out in the comments: openshift#53958
This updates the `/baz/zig` and `/baz/zag` examples.
@openshift/team-documentation PTAL
Copy file name to clipboardexpand all lines: contributing_to_docs/doc_guidelines.adoc
+17-34
Original file line number
Diff line number
Diff line change
@@ -744,56 +744,39 @@ IMPORTANT: You must use `link:` before the start of the URL.
744
744
745
745
IMPORTANT: You cannot link to a repository that is hosted on www.github.com.
746
746
747
-
TIP: If you want to build a link from a URL _without_ changing the text from the actual URL, just print the URL without adding a `[friendly text]` block at the end; it will automatically be rendered as a link.
747
+
TIP: If you want to build a link from a URL _without_ changing the text from the actual URL, print the URL without adding a `[friendly text]` block at the end; it will automatically render as a link.
748
748
749
749
=== Links to internal content
750
-
There are two scenarios for linking to other assemblies:
751
750
752
-
1. Link to another file that exists in the same directory.
753
-
2. Link to another file that exists in a separate directory.
754
-
755
-
The following examples use the example directory structure shown here:
756
-
....
757
-
/
758
-
/foo
759
-
/foo/bar.adoc
760
-
/baz
761
-
/baz/zig.adoc
762
-
/baz/zag.adoc
763
-
....
764
-
765
-
*Link to assembly in same directory*
751
+
If you want to link to other assemblies or modules in the repository, use the following format:
You must use the `.adoc` file extension. The document processor will correctly link this to the resulting HTML file.
772
-
773
-
For example, using the above syntax, if you are working on `zig.adoc` and want to link to `zag.adoc`, do it this way:
774
-
775
-
----
776
-
xref:../zag.adoc#baz-zag[comment]
777
-
----
757
+
Note the following guidelines:
778
758
779
-
where `baz-zag` is the anchor ID at the top of the file `zag.adoc`.
759
+
* You must use the `.adoc` extension.
760
+
* You must specify an anchor ID.
761
+
* You must back up the appropriate number of levels (`../`, `../../`, and so on) to get back to the top-level `openshift-docs/` repository, and then specify the subdirectories to get back down to the assembly.
780
762
781
-
*Link to assembly in different directory*
763
+
For example, if you have the following directory structure:
0 commit comments