Skip to content

Commit da433e7

Browse files
committed
OSDOCS 12388 create dirs for CICD and Observability overviews to make books
fix xrefs fix topicmap fix xref
1 parent 5475e83 commit da433e7

File tree

6 files changed

+44
-20
lines changed

6 files changed

+44
-20
lines changed

_topic_maps/_topic_map.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2060,7 +2060,11 @@ Dir: cicd
20602060
Distros: openshift-enterprise,openshift-origin,openshift-online
20612061
Topics:
20622062
- Name: CI/CD overview
2063-
File: index
2063+
Dir: overview
2064+
Distros: openshift-enterprise,openshift-origin,openshift-online
2065+
Topics:
2066+
- Name: About CI/CD
2067+
File: index
20642068
- Name: Builds using Shipwright
20652069
Dir: builds_using_shipwright
20662070
Distros: openshift-enterprise
@@ -2828,7 +2832,11 @@ Dir: observability
28282832
Distros: openshift-enterprise,openshift-origin
28292833
Topics:
28302834
- Name: Observability overview
2831-
File: index
2835+
Dir: overview
2836+
Distros: openshift-enterprise,openshift-origin
2837+
Topics:
2838+
- Name: About Observability
2839+
File: index
28322840
- Name: Monitoring
28332841
Dir: monitoring
28342842
Distros: openshift-enterprise,openshift-origin

_topic_maps/_topic_map_osd.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,10 @@ Dir: cicd
463463
Distros: openshift-dedicated
464464
Topics:
465465
- Name: CI/CD overview
466-
File: index
466+
Dir: overview
467+
Topics:
468+
- Name: About CI/CD
469+
File: index
467470
# This can be included when Shipwright is ported.
468471
# - Name: Builds using Shipwright
469472
# Dir: builds_using_shipwright
@@ -1187,7 +1190,10 @@ Dir: observability
11871190
Distros: openshift-dedicated
11881191
Topics:
11891192
- Name: Observability overview
1190-
File: index
1193+
Dir: overview
1194+
Topics:
1195+
- Name: About Observability
1196+
File: index
11911197
- Name: Monitoring
11921198
Dir: monitoring
11931199
Distros: openshift-dedicated

_topic_maps/_topic_map_rosa.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -732,7 +732,10 @@ Dir: cicd
732732
Distros: openshift-rosa
733733
Topics:
734734
- Name: CI/CD overview
735-
File: index
735+
Dir: overview
736+
Topics:
737+
- Name: About CI/CD
738+
File: index
736739
# This can be included when Shipwright is ported.
737740
# - Name: Builds using Shipwright
738741
# Dir: builds_using_shipwright
@@ -1485,7 +1488,10 @@ Dir: observability
14851488
Distros: openshift-rosa
14861489
Topics:
14871490
- Name: Observability overview
1488-
File: index
1491+
Dir: overview
1492+
Topics:
1493+
- Name: About Observability
1494+
File: index
14891495
- Name: Monitoring
14901496
Dir: monitoring
14911497
Distros: openshift-rosa

cicd/index.adoc renamed to cicd/overview/index.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="ci-cd-overview"]
3-
= {product-title} CI/CD overview
3+
= About CI/CD
44
include::_attributes/common-attributes.adoc[]
55
:context: ci-cd-overview
66

77
toc::[]
88

99
// The Shipwright, Pipelines, and GitOps content is not currently included
10-
// in the OSD and ROSA docs. As these layered products are added to the
11-
// OSD and ROSA docs, the applicable content and xrefs below should be
10+
// in the OSD and ROSA docs. As these layered products are added to the
11+
// OSD and ROSA docs, the applicable content and xrefs below should be
1212
// included.
1313

1414
{product-title} is an enterprise-ready Kubernetes platform for developers, which enables organizations to automate the application delivery process through DevOps practices, such as continuous integration (CI) and continuous delivery (CD). To meet your organizational needs, the {product-title} provides the following CI/CD solutions:
@@ -32,14 +32,14 @@ For more information, see link:https://docs.openshift.com/builds/latest/about/ov
3232

3333
* Builds using `BuildConfig` objects is a declarative build process to create cloud-native apps. You can define the build process in a YAML file that you use to create a `BuildConfig` object. This definition includes attributes such as build triggers, input parameters, and source code. When deployed, the `BuildConfig` object builds a runnable image and pushes the image to a container image registry. With the `BuildConfig` object, you can create a Docker, Source-to-image (S2I), or custom build.
3434
+
35-
For more information, see xref:../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
35+
For more information, see xref:../../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
3636
endif::openshift-dedicated,openshift-rosa[]
3737

3838
// This is the same para as above, but without the unordered list.
3939
ifdef::openshift-dedicated,openshift-rosa[]
4040
Builds using `BuildConfig` objects is a declarative build process to create cloud-native apps. You can define the build process in a YAML file that you use to create a `BuildConfig` object. This definition includes attributes such as build triggers, input parameters, and source code. When deployed, the `BuildConfig` object builds a runnable image and pushes the image to a container image registry. With the `BuildConfig` object, you can create a Docker, Source-to-image (S2I), or custom build.
4141

42-
For more information, see xref:../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
42+
For more information, see xref:../../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
4343
endif::openshift-dedicated,openshift-rosa[]
4444

4545
// This can be included in OSD and ROSA when the Pipelines doc is ported.
@@ -57,7 +57,7 @@ ifndef::openshift-dedicated,openshift-rosa[]
5757
== OpenShift GitOps
5858
OpenShift GitOps is an Operator that uses Argo CD as the declarative GitOps engine. It enables GitOps workflows across multicluster OpenShift and Kubernetes infrastructure. Using OpenShift GitOps, administrators can consistently configure and deploy Kubernetes-based infrastructure and applications across clusters and development lifecycles.
5959

60-
For more information, see xref:../cicd/gitops/about-redhat-openshift-gitops.adoc#about-redhat-openshift-gitops[About {gitops-title}].
60+
For more information, see xref:../../cicd/gitops/about-redhat-openshift-gitops.adoc#about-redhat-openshift-gitops[About {gitops-title}].
6161
endif::openshift-dedicated,openshift-rosa[]
6262

6363
[id="jenkins-ci-cd"]
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
// This module is included in the following assemblies:
2+
// * about/understanding-openshift-pipelines.adoc
3+
4+
[id="about-workspaces-optional_{context}"]
5+
= Workspaces

observability/index.adoc renamed to observability/overview/index.adoc

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="observability-overview"]
3-
= {product-title} Observability overview
3+
= About Observability
44
include::_attributes/common-attributes.adoc[]
55
:context: observability-overview
66

@@ -36,37 +36,36 @@ Monitor the in-cluster health and performance of your applications running on {p
3636

3737
Monitoring stack components are deployed by default in every {product-title} installation and are managed by the {cmo-first}. These components include Prometheus, Alertmanager, Thanos Querier, and others. The {cmo-short} also deploys the Telemeter Client, which sends a subset of data from platform Prometheus instances to Red Hat to facilitate Remote Health Monitoring for clusters.
3838

39-
For more information, see xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] and xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring].
39+
For more information, see xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] and xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring].
4040

4141
[id="cluster-logging-index_{context}"]
4242
== Logging
4343
Collect, visualize, forward, and store log data to troubleshoot issues, identify performance bottlenecks, and detect security threats. In logging 5.7 and later versions, users can configure the LokiStack deployment to produce customized alerts and recorded metrics.
4444

45-
For more information, see xref:../observability/logging/cluster-logging.adoc#cluster-logging[About Logging].
45+
For more information, see xref:../../observability/logging/cluster-logging.adoc#cluster-logging[About Logging].
4646

4747
ifdef::openshift-enterprise,openshift-origin[]
4848
[id="distr-tracing-architecture-index_{context}"]
4949
== Distributed tracing
5050
Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use it for monitoring distributed transactions, gathering insights into your instrumented services, network profiling, performance and latency optimization, root cause analysis, and troubleshooting the interaction between components in modern cloud-native microservices-based applications.
5151

52-
For more information, see xref:distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture].
52+
For more information, see xref:../../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture].
5353

5454
[id="otel-release-notes-index_{context}"]
5555
== {OTELName}
5656
Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open-source back ends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate.
5757

58-
For more information, see xref:otel/otel-installing.adoc#install-otel[{OTELName}].
58+
For more information, see xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}].
5959

6060
[id="network-observability-overview-index_{context}"]
6161
== Network Observability
6262
Observe the network traffic for {product-title} clusters and create network flows with the Network Observability Operator. View and analyze the stored network flows information in the {product-title} console for further insight and troubleshooting.
6363

64-
For more information, see xref:../observability/network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
64+
For more information, see xref:../../observability/network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
6565

6666
[id="power-monitoring-overview-index_{context}"]
6767
== Power monitoring
6868
Monitor the power usage of workloads and identify the most power-consuming namespaces running in a cluster with key power consumption metrics, such as CPU or DRAM measured at the container level. Visualize energy-related system statistics with the {PM-operator}.
6969

70-
For more information, see xref:../observability/power_monitoring/power-monitoring-overview.adoc#power-monitoring-overview[Power monitoring overview].
70+
For more information, see xref:../../observability/power_monitoring/power-monitoring-overview.adoc#power-monitoring-overview[Power monitoring overview].
7171
endif::[]
72-

0 commit comments

Comments
 (0)