[DOCS] Split Infrastructure Monitoring guide into separate Logs and Metrics docs. by Titch990 · Pull Request #1312 · elastic/docs

Titch990 · 2019-10-18T12:08:25Z

Changes required as a result of splitting Infrastructure Monitoring Guide into separate Logs and Metrics guides.

This is part of a multi-repo change (see elastic/observability-dev#98). DO NOT PUSH UNTIL EVERYTHING IS READY.

Titch990 · 2019-10-18T14:45:10Z

@elasticmachine, run elasticsearch-ci/docs

Titch990 · 2019-10-21T13:00:56Z

Note that this is one of four linked PRs, which need to be merged together to avoid build failures.
elastic/stack-docs#581
#1312 (this one)
elastic/kibana#48633
elastic/beats#14158

DO NOT MERGE UNTIL EVERYTHING IS READY

dedemorton · 2019-10-21T17:40:55Z

Can you please assign @zuketo as the reviewer here since it pertains to info architecture changes?

bmorelli25 · 2019-10-21T17:50:18Z

shared/attributes.asciidoc

+:metrics-ref:          https://www.elastic.co/guide/en/metrics/{branch}
+:metrics-guide:        https://www.elastic.co/guide/en/metrics/guide/{branch}
+:logs-ref:             https://www.elastic.co/guide/en/logs/{branch}
+:logs-guide:           https://www.elastic.co/guide/en/logs/guide/{branch}


Any reason why you want to include these changes in this PR? If you break these changes into a separate PR it would allow you to merge the Kibana and Beats changes prior to splitting the book. That would make the process much simpler than trying to merge 4 PRs at the same time.

To clarify, you could add these new attributes in a new PR, then be able to merge
elastic/kibana#48633 & elastic/beats#14158. That would mean you only have to merge #1312 & elastic/stack-docs#581 at the same time.

Because that's the way it came out. These definitions are needed to resolve broken links else where in the docs. I'm really reluctant to spend any more time unpicking and reworking this any further this unless there is a clear benefit. As far as I can tell, as implemented, this builds across all the affected repos. Any more fiddling is probably going to break things.

Sounds good

bmorelli25 · 2019-10-21T17:56:19Z

conf.yaml

+            title:      Infrastructure Monitoring Guide for 6.5-7.4
+            prefix:     en/infrastructure/guide
+            current:    7.4
+            branches:   [ 7.x, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5 ]


Do we still want to build 7.x and 7.5 here? 7.4 will be the last current so might make sense not to build those other branches.

If we do want to build them, you should update the title in L1624

Continuing to build 7.x and 7.5 would be really confusing, I think.

When we've refactored docs in the past, folks have had a hard time figuring out how to get to the latest docs. I think you should customize the banner message to point to the new docs. (Not everyone will read it, but it will help some folks.)

I've had to leave 7.5 and 7.x for now, because otherwise the 7.5 and 7.x builds break. I can't remove these until I've merged the related changes in Kibana, beats and elsewhere in stack-docs into the 7.5 and 7.x branches to refer to the new docs instead of this one. I'll move the 7.5 and 7.x builds to the new docs as soon as there is nothing in the 75 and 7.x branches that refers to the old docs.

@debadair can you explain what you mean by "customize the banner message"?

@debadair Thanks for the clarification (via Slack). I've created elastic/stack-docs#645 to address this separately so that I can progress this mega-merge without any more hold-ups.

bmorelli25 · 2019-10-21T17:59:17Z

conf.yaml

+            title:      Logs Monitoring Guide
+            prefix:     en/logs/guide
+            current:    master
+            branches:   [ master ]


Should we also build 7.5 here? Then update that to current when 7.5 releases?

Comment as below

bmorelli25 · 2019-10-21T18:00:41Z

conf.yaml

+            title:      Metrics Monitoring Guide
+            prefix:     en/metrics/guide
+            current:    master
+            branches:   [ master ]


Should we also build 7.5 here? Then update that to current when 7.5 releases?

Yes, but that will break the build if I do that before the changes have been pushed to the 7.5 branch, because there are no 7.5 docs to build yet. Unless you know differently, I think I have to update them one at a time.

bmorelli25 · 2019-10-21T18:01:47Z

shared/attributes.asciidoc

@@ -60,6 +59,10 @@
 :curator-ref:          https://www.elastic.co/guide/en/elasticsearch/client/curator/{branch}
 :curator-ref-current:  https://www.elastic.co/guide/en/elasticsearch/client/curator/current
 :infra-guide:          https://www.elastic.co/guide/en/infrastructure/guide/{branch}


I wonder if we should create a new "LEGACY" section in this file and move this attribute to it. That would help prevent someone from accidentally trying to use this attribute in the future.

That's not a bad idea, although if someone tries to use this attribute, the build will break anyway, as the file doesn't exist any more. But I'm all for clarity up front.

bmorelli25 · 2019-10-22T15:21:44Z

conf.yaml

@@ -1363,14 +1363,34 @@ contents:
                        repo:   apm-agent-rum-js
                        path:   docs
          -


@Titch990 How about changing L1215:

title: Observability: APM, Infrastructure, Logs, and Uptime

To this:

title: Observability: APM, Logs, Metrics, and Uptime

Based on this image:

Fair comment. I have a separate task to change Infrastructure to Metrics throughout, so I wasn't too bothered about finding them all yet, but it does make sense to pick this one off now.

zuketo

LGTM

We'll do it in a followup.

nik9000 · 2019-10-28T14:40:30Z

I've dropped the change to attributes.asciidoc and we can do it in a follow up. It was causing the PR build to take a long, long time and we'd like to get a clean build of this ASAP.

We planned to do these attributes updates as part of elastic#1312 but we split them out to speed up the deploy. This adds them back.

We planned to do these attributes updates as part of #1312 but we split them out to speed up the deploy. This adds them back.

Titch990 added the docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo. label Oct 18, 2019

Titch990 force-pushed the MJ-split-infra-logs branch from 350469a to f289228 Compare October 18, 2019 14:30

Titch990 mentioned this pull request Oct 21, 2019

[DOCS] Changes to support the split of the Metrics Guide and the Logs Guide elastic/beats#14158

Merged

Titch990 force-pushed the MJ-split-infra-logs branch from 3b5da6a to ec9ef1a Compare October 21, 2019 13:43

This was referenced Oct 21, 2019

[DOCS] Preliminary work to split Infrastructure and Logs monitoring into two books elastic/stack-docs#581

Merged

[DOCS] Changes to support the split of the Metrics Guide and the Logs Guide elastic/kibana#48633

Merged

Titch990 self-assigned this Oct 21, 2019

Titch990 requested a review from dedemorton October 21, 2019 16:00

bmorelli25 requested review from bmorelli25 and zuketo October 21, 2019 17:47

bmorelli25 reviewed Oct 21, 2019

View reviewed changes

bmorelli25 reviewed Oct 22, 2019

View reviewed changes

zuketo approved these changes Oct 22, 2019

View reviewed changes

Marjorie Jones added 5 commits October 24, 2019 09:57

Changes to split Infrastructure Monitoring into two books

adb3153

Adding helpful note to docbldall alias

03bf73c

More changes to split Infrastructure Monitoring book

4aee938

And another small change

8552ff4

And another fix.

2bb84e0

Titch990 force-pushed the MJ-split-infra-logs branch from b852ab8 to a5fb550 Compare October 24, 2019 08:58

Titch990 marked this pull request as ready for review October 24, 2019 09:02

Addressing review comments

a500d02

Titch990 force-pushed the MJ-split-infra-logs branch from a5fb550 to a500d02 Compare October 28, 2019 13:29

Merge branch 'master' into MJ-split-infra-logs

1e447c5

Drop attributes change

3666a18

We'll do it in a followup.

nik9000 added 2 commits October 28, 2019 10:46

Wooops

15e2826

Double oops

b9961a6

nik9000 merged commit 6430923 into elastic:master Oct 28, 2019

nik9000 added a commit to nik9000/docs that referenced this pull request Oct 28, 2019

Cleanup attributes after docs split

80fb69e

We planned to do these attributes updates as part of elastic#1312 but we split them out to speed up the deploy. This adds them back.

nik9000 mentioned this pull request Oct 28, 2019

Cleanup attributes after docs split #1364

Merged

nik9000 added a commit that referenced this pull request Oct 28, 2019

Cleanup attributes after docs split (#1364)

2d881b4

We planned to do these attributes updates as part of #1312 but we split them out to speed up the deploy. This adds them back.

Conversation

Titch990 commented Oct 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Titch990 commented Oct 18, 2019

Uh oh!

Titch990 commented Oct 21, 2019

Uh oh!

dedemorton commented Oct 21, 2019

Uh oh!

bmorelli25 Oct 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zuketo left a comment

Choose a reason for hiding this comment

Uh oh!

nik9000 commented Oct 28, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Titch990 commented Oct 18, 2019 •

edited

Loading

bmorelli25 Oct 21, 2019 •

edited

Loading