mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
20 lines
629 B
Plaintext
20 lines
629 B
Plaintext
|
|
// Base the file name and the ID on the assembly title. For example:
|
|
// * file name: my-assembly-a.adoc
|
|
// * ID: [id="my-assembly-a"]
|
|
// * Title: = My assembly A
|
|
|
|
// Choose a context that is not too long and encapsulates what this assembly or
|
|
// module is about. Context MUST be unique across the docs set.
|
|
|
|
[id="mod-docs-ocp-references"]
|
|
= Modular docs OpenShift conventions
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: assembly-ocp-conventions
|
|
|
|
toc::[]
|
|
|
|
Before you contribute to the OpenShift docs repo, review the following modular docs conventions.
|
|
|
|
include::modules/mod-docs-ocp-conventions.adoc[leveloffset=+1]
|