Skip to content

Commit 91a09ed

Browse files
authored
Merge pull request #81563 from kalexand-rh/main-api-restructure
restructuring API docs
2 parents 6e8f31e + 475f112 commit 91a09ed

File tree

13 files changed

+457
-582
lines changed

13 files changed

+457
-582
lines changed

_topic_maps/_topic_map.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3475,14 +3475,17 @@ Name: API reference
34753475
Dir: rest_api
34763476
Distros: openshift-enterprise,openshift-origin
34773477
Topics:
3478-
- Name: Understanding API tiers
3479-
File: understanding-api-support-tiers
3480-
- Name: API compatibility guidelines
3481-
File: understanding-compatibility-guidelines
3482-
- Name: Editing kubelet log level verbosity and gathering logs
3483-
File: editing-kubelet-log-level-verbosity
3484-
- Name: API list
3485-
File: index
3478+
- Name: API overview
3479+
Dir: overview
3480+
Topics:
3481+
- Name: Understanding API tiers
3482+
File: understanding-api-support-tiers
3483+
- Name: API compatibility guidelines
3484+
File: understanding-compatibility-guidelines
3485+
- Name: Editing kubelet log level verbosity and gathering logs
3486+
File: editing-kubelet-log-level-verbosity
3487+
- Name: API list
3488+
File: index
34863489
- Name: Common object reference
34873490
Dir: objects
34883491
Topics:

getting_started/openshift-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ describes an application that can be deployed using the Helm CLI.
7979
* **xref:../operators/operator_sdk/osdk-about.adoc#osdk-about[Develop Operators]**: Operators are the preferred method for creating on-cluster applications for {product-title} {product-version}. Learn the workflow for building, testing, and deploying Operators. Then, create your own Operators based on xref:../operators/operator_sdk/ansible/osdk-ansible-support.adoc#osdk-ansible-support[Ansible] or
8080
xref:../operators/operator_sdk/helm/osdk-helm-support.adoc#osdk-helm-support[Helm], or configure xref:../operators/operator_sdk/osdk-monitoring-prometheus.adoc#osdk-monitoring-prometheus[built-in Prometheus monitoring] using the Operator SDK.
8181

82-
* **xref:../rest_api/index.adoc#api-index[REST API reference]**: Learn about {product-title} application programming interface endpoints.
82+
* **xref:../rest_api/overview/index.adoc#api-index[REST API reference]**: Learn about {product-title} application programming interface endpoints.
8383

8484
=== For administrators
8585
* **xref:../architecture/architecture.adoc#architecture-overview-architecture[Understand {product-title} management]**: Learn about components

rest_api/index.adoc

Lines changed: 0 additions & 571 deletions
This file was deleted.

rest_api/overview/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_attributes/

rest_api/overview/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images/

rest_api/overview/index.adoc

Lines changed: 439 additions & 0 deletions
Large diffs are not rendered by default.

rest_api/overview/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules/

rest_api/overview/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../snippets/

0 commit comments

Comments
 (0)