Skip to content

Commit

Permalink
Update doc_guidelines.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
bobfuru committed Oct 18, 2023
1 parent da69e8c commit 325af31
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions contributing_to_docs/doc_guidelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -764,19 +764,19 @@ For example, if you have the following directory structure:

....
openshift-docs/
openshift-docs/foo
openshift-docs/foo/bar.adoc
openshift-docs/baz
openshift-docs/baz/zig.adoc
openshift-docs/test1
openshift-docs/test1/test2.adoc
openshift-docs/test3
openshift-docs/test3/example1.adoc
....

And you are working in `bar.adoc` and want to link to `zig.adoc`, use the following xref:
And you are working in `test2.adoc` and want to link to `example1.adoc`, use the following xref:

----
For more information, see the xref:../baz/zig.adoc#baz-zig[ZIG manual].
For more information, see the xref:../test3/example1.adoc#test3-example1[EXAMPLE1 manual].
----

where `baz-zig` is the anchor ID.
where `test3-example1` is the anchor ID.

== Embedding an external file

Expand Down

0 comments on commit 325af31

Please sign in to comment.