Skip to content

Commit

Permalink
docs: remove ids
Browse files Browse the repository at this point in the history
Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
  • Loading branch information
themr0c authored and gbraad committed Jun 29, 2023
1 parent 0a10e39 commit a574a0b
Show file tree
Hide file tree
Showing 33 changed files with 0 additions and 37 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="accessing-the-openshift-cluster_{context}"]
= Accessing the {openshift} cluster

Access the {ocp} cluster running in the {prod} instance by using the {ocp} web console or {openshift} CLI ([command]`oc`).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="about-configuration_{context}"]
= About {prod} configuration

Use the [command]`{bin} config` command to configure both the [command]`{bin}` executable and the {prod} instance.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="about-presets_{example$snip_{project-context}}"]
= About presets

[role="_abstract"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="about-usage-data-collection_{example$snip_{project-context}}"]
= About usage data collection

{prod} prompts you before use for optional, anonymous usage data collection to assist with development.
Expand Down
1 change: 0 additions & 1 deletion docs/modules/getting_started/partials/con_about.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="about_{context}"]
= About {prod}

{rh-prod} brings a minimal {ocp} 4 cluster and Podman container runtime to your local computer.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="differences-from-production-openshift-install_{context}"]
= Differences from a production {ocp} installation

The {openshift} preset for {rh-prod} provides a regular {ocp} installation with the following notable differences:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="accessing-the-internal-openshift-registry_{context}"]
= Accessing the internal {openshift} registry

The {ocp} cluster running in the {prod} instance includes an internal container image registry by default.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="accessing-the-openshift-cluster-with-oc_{context}"]
= Accessing the {openshift} cluster with the {openshift} CLI

Access the {ocp} cluster managed by {prod} by using the {openshift} CLI ([command]`oc`).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="accessing-the-openshift-web-console_{context}"]
= Accessing the {openshift} web console

Access the {ocp} web console by using your web browser.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="changing-the-selected-preset_{context}"]
= Changing the selected preset

[role="_abstract"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="configuring-the-instance_{context}"]
= Configuring the instance

Use the `cpus` and `memory` properties to configure the default number of vCPUs and amount of memory available to the {prod} instance, respectively.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="configuring-usage-data-collection_{context}"]
= Configuring usage data collection

Consent for usage data collection can be granted or revoked by you at any time using the following configuration commands.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="connecting-to-remote-instance_{context}"]
= Connecting to a remote {prod} instance

Use [application]`dnsmasq` to connect a client machine to a remote server running an {ocp} cluster managed by {prod}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="deleting-the-instance_{context}"]
= Deleting the instance

The [command]`{bin} delete` command deletes an existing {prod} instance.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="deploying-sample-application-with-odo_{context}"]
= Deploying a sample application with `odo`

You can use [command]`odo` to create {openshift} projects and applications from the command line.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="enabling-override-operators_{context}"]
= Enabling override Operators

To verify {prod} can run on a typical notebook, some resource-heavy services get disabled by default.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="getting-shell-access-to-the-openshift-cluster_{context}"]
= Getting shell access to the {openshift} cluster

To access the cluster for troubleshooting or debugging purposes, follow this procedure.
Expand Down
1 change: 0 additions & 1 deletion docs/modules/getting_started/partials/proc_installing.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="installing_{context}"]
= Installing {prod}

{prod} is available as a portable executable for {rhel}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="setting-up-remote-server_{context}"]
= Setting up {prod} on a remote server

Configure a remote server to run an {ocp} cluster provided by {prod}.
Expand Down
1 change: 0 additions & 1 deletion docs/modules/getting_started/partials/proc_setting-up.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="setting-up_{context}"]
= Setting up {prod}

[role="_abstract"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="starting-behind-proxy_{context}"]
= Starting {prod} behind a proxy

You can start {prod} behind a defined proxy using environment variables or configurable properties.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="starting-monitoring_{context}"]
= Starting monitoring

{prod} disables cluster monitoring by default to ensure that {prod} can run on a typical notebook.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="starting-the-instance_{context}"]
= Starting the instance

The [command]`{bin} start` command starts the {prod} instance and configured container runtime.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="stopping-the-instance_{context}"]
= Stopping the instance

The [command]`{bin} stop` command stops the running {prod} instance and container runtime.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="troubleshooting-bundle-version-mismatch_{context}"]
= Troubleshooting bundle version mismatch

Created {prod} instances contain bundle information and instance data.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="troubleshooting-expired-certificates_{context}"]
= Troubleshooting expired certificates

The system bundle of {ocp} in each released [command]`{bin}` executable expires 1 year after the release.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="troubleshooting-unknown-issues_{context}"]
= Troubleshooting unknown issues

Resolve most issues by restarting {prod} with a clean state.
Expand Down
1 change: 0 additions & 1 deletion docs/modules/getting_started/partials/proc_upgrading.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="upgrading_{context}"]
= Upgrading {prod}

Newer versions of the {prod} executable require manual set up to prevent potential incompatibilities with earlier versions.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="viewing-configuration_{context}"]
= Viewing {prod} configuration

The {prod} executable provides commands to view configurable properties and the current {prod} configuration.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
[id="dns-configuration_{context}"]
= DNS configuration details

[id="dns-configuration-general{context}"]
== General DNS setup

The {ocp} cluster managed by {prod} uses 2 DNS domain names, `crc.testing` and `apps-crc.testing`.
Expand All @@ -14,7 +12,6 @@ These DNS domains are served by a `dnsmasq` DNS container running inside the {pr
The [command]`{bin} setup` command detects and adjusts your system DNS configuration so that it can resolve these domains.
Additional checks are done to verify DNS is properly configured when running [command]`{bin} start`.

[id="dns-configuration-linux_{context}"]
== Linux

On Linux, depending on your distribution, {prod} expects the following DNS configuration:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
[id="minimum-system-requirements_{context}"]
= Minimum system requirements

[role="_abstract"]
{prod} has the following minimum hardware and operating system requirements.

[id="minimum-system-requirements-hardware_{context}"]
== Hardware requirements

{prod} is supported on these architectures:
Expand Down Expand Up @@ -40,7 +38,6 @@ To assign more resources to the {prod} instance, see link:{crc-gsg-url}#configur
* 2 GB of free memory
* 35 GB of storage space

[id="minimum-system-requirements-operating-system_{context}"]
== Operating system requirements

{prod} requires the following minimum version of a supported operating system:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="required-software-packages_{context}"]
= Required software packages for Linux

{prod} requires the `libvirt` and `NetworkManager` packages to run on Linux.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[id="reserved-ip-subnets_{context}"]
= Reserved IP subnets

The {ocp} cluster managed by {prod} reserves IP subnets for internal use, which should not collide with your host network.
Expand Down

0 comments on commit a574a0b

Please sign in to comment.