Skip to content

Commit e1b1563

Browse files
doc: Add external link icons (#36)
1 parent 22198a2 commit e1b1563

File tree

7 files changed

+17
-17
lines changed

7 files changed

+17
-17
lines changed

docs/modules/opensearch/pages/getting_started/first_steps.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ Now you can create your own indexes, populate them with data and search for it.
8080

8181
== What's next
8282

83-
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].
83+
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}^].

docs/modules/opensearch/pages/getting_started/installation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The tool will show
2929
include::example$getting_started/install_output.txt[]
3030
3131
TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`.
32-
For example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind].
32+
For example, you can use the `--cluster kind` flag to create a Kubernetes cluster with https://kind.sigs.k8s.io/[kind{external-link-icon}^].
3333
--
3434
3535
Helm::

docs/modules/opensearch/pages/index.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99
:feature-tracker: https://features.stackable.tech/unified
1010

1111
[.link-bar]
12-
* {github}[GitHub {external-link-icon}^]
13-
* {feature-tracker}[Feature Tracker {external-link-icon}^]
14-
* {crd}[CRD documentation {external-link-icon}^]
12+
* {github}[GitHub{external-link-icon}^]
13+
* {feature-tracker}[Feature Tracker{external-link-icon}^]
14+
* {crd}[CRD documentation{external-link-icon}^]
1515

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

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

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

3030
=== Custom resources
3131

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

5959
== Useful links
6060

61-
* The {github}[opensearch-operator {external-link-icon}^] GitHub repository
62-
* The operator feature overview in the {feature-tracker}[feature tracker {external-link-icon}^]
63-
* The {crd-opensearchcluster}[OpenSearchCluster {external-link-icon}^] CRD documentation
61+
* The {github}[opensearch-operator{external-link-icon}^] GitHub repository
62+
* The operator feature overview in the {feature-tracker}[feature tracker{external-link-icon}^]
63+
* The {crd-opensearchcluster}[OpenSearchCluster{external-link-icon}^] CRD documentation

docs/modules/opensearch/pages/usage-guide/configuration-environment-overrides.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ They are added unchanged to the configuration file.
4040
Care must be taken to produce a valid configuration.
4141

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

4545
The file `opensearch.yml` is a YAML file, where deep structures are possible.
4646
On the other hand, `configOverrides` are only flat key-value pairs.

docs/modules/opensearch/pages/usage-guide/monitoring.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ stringData:
8383
- opendistro_security_anonymous_backendrole
8484
----
8585
<1> If anonymous authentication is enabled, then all defined HTTP authenticators are non-challenging.
86-
<2> Enable https://docs.opensearch.org/latest/security/access-control/anonymous-authentication/[anonymous authentication]
86+
<2> Enable https://docs.opensearch.org/latest/security/access-control/anonymous-authentication/[anonymous authentication{external-link-icon}^]
8787
<3> Create a role "monitoring" with the required permissions for the Prometheus endpoint
8888
<4> Map the role "monitoring" to the backend role "opendistro_security_anonymous_backendrole" that is assigned to the anonymous user
8989

90-
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:
90+
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:
9191

9292
[source,yaml]
9393
----

docs/modules/opensearch/pages/usage-guide/node-roles.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In a production cluster, you probably want to assign different roles to the node
3131
This can be achieved by creating multiple role groups and configuring their node roles.
3232
The node roles configured at the role group level override the ones from the role level.
3333

34-
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:
34+
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:
3535

3636
[source,yaml]
3737
----
@@ -65,4 +65,4 @@ The following roles are currently supported by the operator:
6565
* `search`
6666
* `warm`
6767
68-
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.
68+
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.

docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
== Storage for data volumes
55

6-
You can mount volumes where data is stored by specifying https://kubernetes.io/docs/concepts/storage/persistent-volumes[PersistentVolumeClaims] for each individual role group:
6+
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:
77

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

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

30-
A minimal HA setup consisting of 3 nodes has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]:
30+
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}^]:
3131

3232
* `300m` CPU request
3333
* `1200m` CPU limit

0 commit comments

Comments
 (0)