Skip to content

Commit 8c5f3dc

Browse files
committed
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
1 parent a725b8e commit 8c5f3dc

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

contributing_to_docs/doc_guidelines.adoc

+3-8
Original file line numberDiff line numberDiff line change
@@ -747,19 +747,14 @@ IMPORTANT: You cannot link to a repository that is hosted on www.github.com.
747747
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.
748748

749749
=== Links to internal content
750-
There are two scenarios for linking to other assemblies:
751-
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:
750+
If you want to link to other assemblies, refer to the following example directory structure shown here:
756751
....
757752
/
758753
/foo
759754
/foo/bar.adoc
760755
/baz
761-
/baz/zig.adoc
762-
/baz/zag.adoc
756+
xref:../baz/zig.adoc
757+
xref:../baz/zag.adoc
763758
....
764759

765760
*Link to assembly in same directory*

0 commit comments

Comments
 (0)