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.

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][ML]Updates prebuilt ml jobs file links #918

Merged
merged 4 commits into from
Mar 8, 2020

Conversation

benskelker
Copy link
Contributor

@benskelker benskelker commented Mar 3, 2020

Updates links in the ML SIEM prebuilt jobs section so it can be included in the SIEM docs without breaking links.

@benskelker benskelker changed the title include link test [Docs][ML]Updates prebuilt ml jobs file links Mar 3, 2020
@benskelker benskelker marked this pull request as ready for review March 3, 2020 15:06
@benskelker benskelker requested review from szabosteve and lcawl March 3, 2020 15:06
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM!

These {anomaly-jobs} appear by default in the Anomaly Detection interface of the
{siem-guide}/machine-learning.html[SIEM app] in {kib}. They help you
automatically detect file system and network anomalies on your hosts. The list
below contains the jobs organized by `agent.type` (Auditbeat, Packetbeat, and
Winlogbeat).

// tag::siem-jobs[]
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems likely to work fine, though for future reference I think it's fine to just make them as external links (i.e. use xxx.html instead of <>) in the context of both books. That's what we did for links in release highlights and breaking changes (e.g. https://www.elastic.co/guide/en/elastic-stack/current/elasticsearch-highlights.html) which are re-used in both the Installation/Upgrade Guide and individual product books.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll do this now as it keeps thing simple.

@benskelker
Copy link
Contributor Author

@szabosteve - can you just give this another quick look? I updated as Lisa suggested.
Thanks,

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@benskelker benskelker merged commit a3b7977 into elastic:master Mar 8, 2020
@benskelker benskelker deleted the single_source_siem_ml_jobs branch March 8, 2020 06:23
benskelker added a commit to benskelker/stack-docs that referenced this pull request Mar 8, 2020
* include link test

* fixes links

* removes SIEM changes

* swaps atts for refs
benskelker added a commit to benskelker/stack-docs that referenced this pull request Mar 8, 2020
* include link test

* fixes links

* removes SIEM changes

* swaps atts for refs
benskelker added a commit that referenced this pull request Mar 8, 2020
* include link test

* fixes links

* removes SIEM changes

* swaps atts for refs
benskelker added a commit that referenced this pull request Mar 8, 2020
* include link test

* fixes links

* removes SIEM changes

* swaps atts for refs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants