Skip to content

Commit 09f9d3e

Browse files
committed
[DOCS] Fixes out-dated links (#803)
1 parent d58636e commit 09f9d3e

File tree

9 files changed

+17
-37
lines changed

9 files changed

+17
-37
lines changed

docs/en/install-upgrade/upgrading-stack.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ production cluster.
5252

5353
. Back up your data. You **cannot roll back** to an earlier version unless
5454
you have a snapshot of your data. For information about creating snapshots, see
55-
{ref}/modules-snapshots.html[Snapshot and Restore].
55+
{ref}/snapshot-restore.html[Snapshot and restore].
5656

5757
. Consider closing {ml} jobs before you start the upgrade process. While {ml}
5858
jobs can continue to run during a rolling upgrade, it increases the overhead

docs/en/stack/ml/anomaly-detection/calendars.asciidoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ iCalendar (`.ics`) file in {kib} or a JSON file in the
3232
for that time period. Machine learning results are not updated retroactively.
3333
* If your iCalendar file contains recurring events, only the first occurrence is
3434
imported.
35-
* Bucket results are generated during scheduled events but they have an
36-
anomaly score of zero. For more information about bucket results, see
37-
{ref}/ml-results-resource.html[Results resources].
35+
* <<ml-bucket-results,Bucket results>> are generated during scheduled events but
36+
they have an anomaly score of zero.
3837
* If you use long or frequent scheduled events, it might take longer for the
3938
{ml} analytics to learn to model your data and some anomalous behavior might be
4039
missed.

docs/en/stack/ml/anomaly-detection/datafeeds.asciidoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,9 @@ for analysis, which is the simpler and more common scenario.
99
If you create {anomaly-jobs} in {kib}, you must use {dfeeds}. When you create a
1010
job, you select an index pattern and {kib} configures the {dfeed} for you under
1111
the covers. If you use APIs instead, you can create a {dfeed} by using the
12-
{ref}/ml-put-datafeed.html[create {dfeeds} API] after you create an
13-
{anomaly-job}. You can associate only one {dfeed} with each job.
14-
15-
For a description of all the {dfeed} properties, see
16-
{ref}/ml-datafeed-resource.html[Datafeed resources].
12+
create {dfeeds} API after you create an {anomaly-job}. You can associate only
13+
one {dfeed} with each job. For a description of all the {dfeed} properties, see
14+
the {ref}/ml-put-datafeed.html[create {dfeeds} API].
1715

1816
To start retrieving data from {es}, you must start the {dfeed}. When you start
1917
it, you can optionally specify start and end times. If you do not specify an

docs/en/stack/ml/anomaly-detection/getting-started-multi.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,9 +176,7 @@ might differ slightly. This disparity occurs because for each job we generate
176176
bucket results, influencer results, and record results. Anomaly scores are
177177
generated for each type of result. The anomaly timeline uses the bucket-level
178178
anomaly scores. The list of top influencers uses the influencer-level anomaly
179-
scores. The list of anomalies uses the record-level anomaly scores. For more
180-
information about these different result types, see
181-
{ref}/ml-results-resource.html[Results Resources].
179+
scores. The list of anomalies uses the record-level anomaly scores.
182180

183181
Click on a section in the swim lanes to obtain more information about the
184182
anomalies in that time period. For example, click on the red section in the swim

docs/en/stack/ml/anomaly-detection/getting-started-single.asciidoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,9 @@ The status of the mathematical models. When you create jobs by using the APIs or
159159
by using the advanced options in {kib}, you can specify a `model_memory_limit`.
160160
That value is the maximum amount of memory resources that the mathematical
161161
models can use. Once that limit is approached, data pruning becomes more
162-
aggressive. Upon exceeding that limit, new entities are not modeled. For more
163-
information about this setting, see
164-
{ref}/ml-job-resource.html#ml-apilimits[Analysis Limits]. The memory status
165-
field reflects whether you have reached or exceeded the model memory limit. It
166-
can have one of the following values: +
162+
aggressive. Upon exceeding that limit, new entities are not modeled. The memory
163+
status field reflects whether you have reached or exceeded the model memory
164+
limit. It can have one of the following values: +
167165
`ok`::: The models stayed below the configured value.
168166
`soft_limit`::: The models used more than 60% of the configured memory limit
169167
and older unused models will be pruned to free up space.

docs/en/stack/ml/anomaly-detection/job-tips.asciidoc

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ The bucket span is the time interval that {ml} analytics use to summarize and
1717
model data for your job. When you create an {anomaly-job} in {kib}, you can
1818
choose to estimate a bucket span value based on your data characteristics.
1919

20-
NOTE: The bucket span must contain a valid time interval. For more information,
21-
see {ref}/ml-job-resource.html#ml-analysisconfig[Analysis configuration objects].
20+
NOTE: The bucket span must contain a valid time interval. See
21+
{ref}/common-options.html#time-units[Time units].
2222

2323
If you choose a value that is larger than one day or is significantly different
2424
than the estimated value, you receive an informational message. For more
@@ -98,9 +98,4 @@ If you are using {ece} or the hosted Elasticsearch Service on Elastic Cloud,
9898
`xpack.ml.max_model_memory_limit` is set to prevent you from creating jobs
9999
that cannot be allocated to any {ml} nodes in the cluster. If you find that you
100100
cannot increase `model_memory_limit` for your {ml} jobs, the solution is to
101-
increase the size of the {ml} nodes in your cluster.
102-
103-
For more information about the `model_memory_limit` property and the
104-
`xpack.ml.max_model_memory_limit` setting, see
105-
{ref}/ml-job-resource.html#ml-analysisconfig[Analysis limits] and
106-
{ref}/ml-settings.html[Machine learning settings].
101+
increase the size of the {ml} nodes in your cluster.

docs/en/stack/ml/anomaly-detection/jobs.asciidoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,13 @@ in a population. There are also multiple options for splitting the data into
1919
categories and partitions. Some of these more advanced job configurations
2020
are described in the following section: <<anomaly-examples>>.
2121

22-
For a description of all the job properties, see
23-
{ref}/ml-job-resource.html[{anomaly-jobs-cap} resources].
22+
For a description of all the job properties, see the
23+
{ref}/ml-put-job.html[create {anomaly-jobs} API].
2424

2525
In {kib}, there are wizards that help you create specific types of jobs, such
2626
as _single metric_, _multi-metric_, and _population_ jobs. A single metric job
2727
is just a job with a single detector and limited job properties. To have access
2828
to all of the job properties in {kib}, you must choose the _advanced_ job wizard.
29-
//If you want to try creating single and multi-metrics jobs in {kib} with sample
30-
//data, see <<ml-getting-started>>.
3129

3230
You can also optionally assign jobs to one or more _job groups_. You can use
3331
job groups to view the results from multiple jobs more easily and to expedite

docs/en/stack/ml/anomaly-detection/limitations.asciidoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Missing fields might be expected due to the structure of the data and therefore
103103
do not generate poor results.
104104

105105
For more information about `missing_field_count`,
106-
see {ref}/ml-jobstats.html#ml-datacounts[Data Counts Objects].
106+
see the {ref}/ml-get-job-stats.html[get {anomaly-job} statistics API].
107107

108108

109109
[float]
@@ -145,9 +145,6 @@ this additional model information for every bucket might be problematic. If you
145145
are not certain that you need this option or if you experience performance
146146
issues, edit your job configuration to disable this option.
147147

148-
For more information, see
149-
{ref}/ml-job-resource.html#ml-apimodelplotconfig[Model Plot Config].
150-
151148
Likewise, when you create a single or multi-metric job in {kib}, in some cases
152149
it uses aggregations on the data that it retrieves from {es}. One of the
153150
benefits of summarizing data this way is that {es} automatically distributes
@@ -161,8 +158,6 @@ in performance that is gained by pre-aggregating the data makes the potentially
161158
poorer precision worthwhile. If you want to view or change the aggregations
162159
that are used in your job, refer to the `aggregations` property in your {dfeed}.
163160

164-
For more information, see {ref}/ml-datafeed-resource.html[Datafeed Resources].
165-
166161
[float]
167162
=== Security integration
168163

docs/en/stack/ml/anomaly-detection/troubleshooting.asciidoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,7 @@ abbreviated name, it is displayed.
8686
Create {anomaly-jobs} in {kib} or ensure that you create {anomaly-jobs} with
8787
valid identifiers when you use the APIs. For more information about valid
8888
identifiers, see
89-
{ref}/ml-put-job.html[Create {anomaly-jobs} API] or
90-
{ref}/ml-job-resource.html[{anomaly-detect-cap} job resources].
89+
{ref}/ml-put-job.html[Create {anomaly-jobs} API].
9190

9291
[[ml-upgradedf]]
9392

0 commit comments

Comments
 (0)