Skip to content
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

[DOCS] Update tab-widgets internal links to external #19947

Merged
merged 1 commit into from
Jul 16, 2020
Merged

[DOCS] Update tab-widgets internal links to external #19947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions libbeat/docs/tab-widgets/set-connection.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
// tag::cloud[]

Specify the <<configure-cloud-id,`cloud.id`>> of your {ess}, and set
<<configure-cloud-id,`cloud.auth`>> to a user who is authorized to
:beatname_url: {beats-ref-root}/{beatname_lc}/{branch}

Specify the {beatname_url}/configure-cloud-id.html[cloud.id] of your {ess}, and set
{beatname_url}/configure-cloud-id.html[cloud.auth] to a user who is authorized to
set up {beatname_uc}. For example:

["source","yaml",subs="attributes"]
Expand All @@ -12,7 +14,7 @@ cloud.auth: "{beatname_lc}_setup:{pwd}" <1>
<1> This examples shows a hard-coded password, but you should store sensitive
values
ifndef::serverless[]
in the <<keystore,secrets keystore>>.
in the {beatname_url}/keystore.html[secrets keystore].
endif::[]
ifdef::serverless[]
in environment variables.
Expand All @@ -34,7 +36,7 @@ output.elasticsearch:
<1> This examples shows a hard-coded password, but you should store sensitive
values
ifndef::serverless[]
in the <<keystore,secrets keystore>>.
in the {beatname_url}/keystore.html[secrets keystore].
endif::[]
ifdef::serverless[]
in environment variables.
Expand All @@ -60,3 +62,4 @@ specified for the {es} output.
`kibana_user` {ref}/built-in-roles.html[built-in role] or equivalent
privileges.
// end::self-managed[]

9 changes: 6 additions & 3 deletions libbeat/docs/tab-widgets/start.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
// tag::deb[]

:beatname_url: {beats-ref-root}/{beatname_lc}/{branch}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can't be added here as it doesn't resolve for the attributes that are used in tagged regions elsewhere. This needs to be added everywhere that attribute is used.

@dedemorton, I know you were against putting this in the docs repo initially (and I was too after hearing your argument), but maybe we can put it in the docs repo with a big comment around it saying not to use it for external book linking? I'm struggling to think of a better option

Suggested change
:beatname_url: {beats-ref-root}/{beatname_lc}/{branch}
:beatname_url: {beats-ref-root}/{beatname_lc}/{branch}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should work because the beatname_url attribute is only referenced in the widgets right?

At any rate, I can see that including it in the widget adds a LOT of repetition, so I think you're probably right. Put it in with the other shared attributes and mark it clearly.

@EamonnTP Sorry to give you the run around on this, but I think Brandon is right.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As it turns out, @dedemorton, you were right 😄


["source","sh",subs="attributes"]
----------------------------------------------------------------------
sudo service {beatname_pkg} start
----------------------------------------------------------------------

// tag::initd-note[]
NOTE: If you use an `init.d` script to start {beatname_uc}, you can't specify command
line flags (see <<command-line-options>>). To specify flags, start {beatname_uc} in
line flags (see {beatname_url}/command-line-options.html[Command reference]). To specify flags, start {beatname_uc} in
bmorelli25 marked this conversation as resolved.
Show resolved Hide resolved
the foreground.

// end::initd-note[]

Also see <<running-with-systemd>>.
Also see {beatname_url}/running-with-systemd.html[{beatname_uc} and systemd].
// end::deb[]

// tag::rpm[]
Expand All @@ -22,7 +25,7 @@ sudo service {beatname_pkg} start

include::start.asciidoc[tag=initd-note]

Also see <<running-with-systemd>>.
Also see {beatname_url}/running-with-systemd.html[{beatname_uc} and systemd].

// end::rpm[]

Expand Down