Skip to content

Commit f990067

Browse files
authored
Fix links (#970)
1 parent 078d38d commit f990067

File tree

6 files changed

+48
-60
lines changed

6 files changed

+48
-60
lines changed

local-antora-playbook.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,14 @@ antora:
6565
- require: '@redpanda-data/docs-extensions-and-macros/extensions/add-global-attributes'
6666
- require: '@redpanda-data/docs-extensions-and-macros/extensions/version-fetcher/set-latest-version'
6767
- require: '@redpanda-data/docs-extensions-and-macros/extensions/replace-attributes-in-attachments'
68+
data:
69+
replacements:
70+
- components:
71+
- 'ROOT'
72+
- 'redpanda-labs'
73+
file_patterns:
74+
- '**/docker-compose.yaml'
75+
- '**/docker-compose.yml'
6876
- require: '@redpanda-data/docs-extensions-and-macros/extensions/validate-attributes'
6977
- require: '@redpanda-data/docs-extensions-and-macros/extensions/find-related-docs'
7078
- require: '@redpanda-data/docs-extensions-and-macros/extensions/find-related-labs'

modules/get-started/pages/intro-to-rpk.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@ After you install `rpk`, you can use it to:
1111
* Set up access control lists (ACLs) and other security features
1212
* Create topics, produce to topics, and consume from topics
1313
14-
See also:
14+
See also:
15+
1516
* xref:get-started:rpk-install.adoc[]
1617
* xref:get-started:config-rpk-profile.adoc[]
18+
// This topic is not available in our Cloud docs.
19+
ifndef::env-cloud[]
1720
* xref:get-started:rpk-quickstart.adoc[]
21+
endif::[]
1822
1923
== Specify command properties
2024

modules/get-started/pages/rpk-install.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ include::get-started:partial$install-rpk-macos.adoc[]
3535

3636
== Next steps
3737

38-
Explore rpk with the xref:rpk-quickstart.adoc[] guide.
3938
For the complete list of `rpk` commands and their syntax, see the xref:reference:rpk/index.adoc[rpk reference].
40-
4139
// end::single-source[]
40+
// Excluding the rpk quickstart from single-sourcing because it is not available in our Cloud docs.
41+
Explore `rpk` with the xref:get-started:rpk-quickstart.adoc[].

modules/get-started/partials/install-rpk-linux.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-
2323
----
2424
====
2525

26-
TIP: You can use `rpk` on Windows with https://learn.microsoft.com/windows/wsl/install[WSL]^. Note that commands that require Redpanda to be installed on your machine are not supported, such as xref:reference:rpk/rpk-container.adoc[`rpk container`] commands, xref:reference:rpk/rpk-iotune.adoc[`rpk iotune`], and xref:reference:rpk/rpk-redpanda.adoc[`rpk redpanda`] commands.
26+
TIP: You can use `rpk` on Windows only with https://learn.microsoft.com/windows/wsl/install[WSL^]. However, commands that require Redpanda to be installed on your machine are not supported, such as xref:ROOT:reference:rpk/rpk-container/rpk-container.adoc[`rpk container`] commands, xref:ROOT:reference:rpk/rpk-iotune.adoc[`rpk iotune`], and xref:ROOT:reference:rpk/rpk-redpanda/rpk-redpanda.adoc[`rpk redpanda`] commands.
2727

2828
// end::latest[]
2929

0 commit comments

Comments
 (0)