Skip to content

doc: Add external link icons #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
siegfriedweber merged 2 commits into from
Sep 22, 2025
Merged

doc: Add external link icons #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e85b8ae
doc: Add external link icons
siegfriedweber Sep 16, 2025
cd52a77
Merge branch 'main' into doc/external-links
siegfriedweber Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/opensearch/pages/getting_started/first_steps.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ Now you can create your own indexes, populate them with data and search for it.

== What's next

Check the xref:usage-guide/index.adoc[] to find out more about configuring your OpenSearch instance or have a look at the OpenSearch documentation to https://docs.opensearch.org/docs/latest/getting-started/[ingest, search or visualize your data with OpenSearch Dashboards].
Check the xref:usage-guide/index.adoc[] to find out more about configuring your OpenSearch instance or have a look at the OpenSearch documentation to https://docs.opensearch.org/docs/latest/getting-started/[ingest, search or visualize your data with OpenSearch Dashboards{external-link-icon}^].
2 changes: 1 addition & 1 deletion docs/modules/opensearch/pages/getting_started/installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The tool will show
include::example$getting_started/install_output.txt[]

TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`.
For example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind].
For example, you can use the `--cluster kind` flag to create a Kubernetes cluster with https://kind.sigs.k8s.io/[kind{external-link-icon}^].
--

Helm::
Expand Down
16 changes: 8 additions & 8 deletions docs/modules/opensearch/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
:feature-tracker: https://features.stackable.tech/unified

[.link-bar]
* {github}[GitHub {external-link-icon}^]
* {feature-tracker}[Feature Tracker {external-link-icon}^]
* {crd}[CRD documentation {external-link-icon}^]
* {github}[GitHub{external-link-icon}^]
* {feature-tracker}[Feature Tracker{external-link-icon}^]
* {crd}[CRD documentation{external-link-icon}^]

The Stackable operator for {opensearch}[OpenSearch] deploys and manages OpenSearch clusters on Kubernetes.
The Stackable operator for {opensearch}[OpenSearch{external-link-icon}^] deploys and manages OpenSearch clusters on Kubernetes.
OpenSearch is a powerful search and analytics engine built on Apache Lucene.
This operator helps you manage your OpenSearch instances on Kubernetes efficiently.

Expand All @@ -25,7 +25,7 @@ It guides you through installing the operator, connecting to your OpenSearch ins
== Operator model

The operator manages the _OpenSearchCluster_ resource.
It creates a number of different Kubernetes resources based on this {crs}[custom resource].
It creates a number of different Kubernetes resources based on this {crs}[custom resource{external-link-icon}^].

=== Custom resources

Expand Down Expand Up @@ -58,6 +58,6 @@ include::partial$supported-versions.adoc[]

== Useful links

* The {github}[opensearch-operator {external-link-icon}^] GitHub repository
* The operator feature overview in the {feature-tracker}[feature tracker {external-link-icon}^]
* The {crd-opensearchcluster}[OpenSearchCluster {external-link-icon}^] CRD documentation
* The {github}[opensearch-operator{external-link-icon}^] GitHub repository
* The operator feature overview in the {feature-tracker}[feature tracker{external-link-icon}^]
* The {crd-opensearchcluster}[OpenSearchCluster{external-link-icon}^] CRD documentation
2 changes: 1 addition & 1 deletion docs/modules/opensearch/pages/usage-guide/configuration-environment-overrides.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ They are added unchanged to the configuration file.
Care must be taken to produce a valid configuration.

For a list of configuration options, we refer to the
https://docs.opensearch.org/docs/latest/install-and-configure/configuring-opensearch/index/[Configuring OpenSearch] section in the OpenSearch documentation.
https://docs.opensearch.org/docs/latest/install-and-configure/configuring-opensearch/index/[Configuring OpenSearch{external-link-icon}^] section in the OpenSearch documentation.

The file `opensearch.yml` is a YAML file, where deep structures are possible.
On the other hand, `configOverrides` are only flat key-value pairs.
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/opensearch/pages/usage-guide/monitoring.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,11 @@ stringData:
- opendistro_security_anonymous_backendrole
----
<1> If anonymous authentication is enabled, then all defined HTTP authenticators are non-challenging.
<2> Enable https://docs.opensearch.org/latest/security/access-control/anonymous-authentication/[anonymous authentication]
<2> Enable https://docs.opensearch.org/latest/security/access-control/anonymous-authentication/[anonymous authentication{external-link-icon}^]
<3> Create a role "monitoring" with the required permissions for the Prometheus endpoint
<4> Map the role "monitoring" to the backend role "opendistro_security_anonymous_backendrole" that is assigned to the anonymous user

If you use the https://prometheus-operator.dev/[Prometheus Operator] to install Prometheus, then you can define a https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.ServiceMonitor[ServiceMonitor] to collect the metrics:
If you use the https://prometheus-operator.dev/[Prometheus Operator{external-link-icon}^] to install Prometheus, then you can define a https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.ServiceMonitor[ServiceMonitor{external-link-icon}^] to collect the metrics:

[source,yaml]
----
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/opensearch/pages/usage-guide/node-roles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ In a production cluster, you probably want to assign different roles to the node
This can be achieved by creating multiple role groups and configuring their node roles.
The node roles configured at the role group level override the ones from the role level.

For instance, if you want to deploy https://docs.opensearch.org/docs/latest/tuning-your-cluster/[the sample cluster from the OpenSearch documentation] that has one dedicated cluster manager node, one dedicated coordinating node and two data nodes, you could configure the role groups as follows:
For instance, if you want to deploy https://docs.opensearch.org/docs/latest/tuning-your-cluster/[the sample cluster from the OpenSearch documentation{external-link-icon}^] that has one dedicated cluster manager node, one dedicated coordinating node and two data nodes, you could configure the role groups as follows:

[source,yaml]
----
Expand Down Expand Up @@ -65,4 +65,4 @@ The following roles are currently supported by the operator:
* `search`
* `warm`

We refer to https://docs.opensearch.org/docs/latest/install-and-configure/configuring-opensearch/configuration-system/[the OpenSearch documentation] for an explanation of the roles.
We refer to https://docs.opensearch.org/docs/latest/install-and-configure/configuring-opensearch/configuration-system/[the OpenSearch documentation{external-link-icon}^] for an explanation of the roles.
4 changes: 2 additions & 2 deletions docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

== Storage for data volumes

You can mount volumes where data is stored by specifying https://kubernetes.io/docs/concepts/storage/persistent-volumes[PersistentVolumeClaims] for each individual role group:
You can mount volumes where data is stored by specifying https://kubernetes.io/docs/concepts/storage/persistent-volumes[PersistentVolumeClaims{external-link-icon}^] for each individual role group:

[source,yaml]
----
Expand All @@ -27,7 +27,7 @@ On role groups with only the `cluster_manager` node role, you probably want to d

include::home:concepts:stackable_resource_requests.adoc[]

A minimal HA setup consisting of 3 nodes has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]:
A minimal HA setup consisting of 3 nodes has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements{external-link-icon}^]:

* `300m` CPU request
* `1200m` CPU limit
Expand Down
Loading