mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
36 lines
1.3 KiB
Plaintext
36 lines
1.3 KiB
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.
|
|
|
|
// Not sure if this guide is correct with the current guidelines anymore. Need to validate.
|
|
|
|
[id="getting-started-modular-docs-ocp"]
|
|
= Getting started with modular docs on OpenShift
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: assembly-gsg
|
|
|
|
toc::[]
|
|
|
|
This is the modular docs getting started guide for the OpenShift documentation
|
|
team and anyone who might be contributing content to it.
|
|
|
|
This guide has been written using the format of the modular docs
|
|
initiative.
|
|
|
|
== Prerequisites
|
|
|
|
* You have read through and familiarized yourself with the
|
|
link:https://redhat-documentation.github.io/modular-docs[Red Hat CCS modular docs guide].
|
|
* You have reviewed
|
|
xref:../mod_docs_guide/mod-docs-conventions-ocp.adoc#mod-docs-ocp-references[the Modular Docs OpenShift Conventions].
|
|
* [Optional] You have received the modular docs training.
|
|
* You know how to use Git.
|
|
|
|
include::modules/creating-your-first-content.adoc[leveloffset=+1]
|
|
|
|
// include::modules/mod-docs-ocp-conventions.adoc[leveloffset+=1]
|