Skip to content

Commit ade9c43

Browse files
authored
Merge pull request #45432 from Amrita42/auto-generation
added the two books that are auto-generated
2 parents 5e69ef7 + 0f6f86b commit ade9c43

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,19 @@ In the example, `cloud-provider-first` and `cloud-provider` are not defined by t
392392
For more information about creating text snippets, see the
393393
link:https://redhat-documentation.github.io/modular-docs/#using-text-snippets[Red Hat modular docs reference guide]
394394

395+
[id="Auto-generated-content"]
396+
== Auto-generated content
397+
398+
The following content is auto-generated in each release and must not be manually edited:
399+
400+
* The OpenShift CLI (`oc`) command references `modules/oc-by-example-content.adoc` and `modules/oc-adm-by-example-content.adoc`.
401+
* The following API references content in the `rest_api` folder: the contents of all `<topic>_apis` subfolders and the `rest_api/objects/index.adoc` and `rest_api/index.adoc` assemblies.
402+
403+
[NOTE]
404+
====
405+
If the content in these files needs to be updated, the update must be made in the applicable code repository where these files are generated from. The updates are reflected when the files are generated the next time, for example a future release. For help with where to make the updates, you can contact https://github.com/bergerhoffer[Andrea Hoffer] for the CLI docs or https://github.com/jboxman-rh[Jason Boxman] for the API docs.
406+
====
407+
395408
[id="using-conscious-language"]
396409
== Using conscious language
397410

0 commit comments

Comments
 (0)