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

Add logs section #154

Merged
merged 2 commits into from
Oct 12, 2020
Merged

Add logs section #154

merged 2 commits into from
Oct 12, 2020

Conversation

ChrsMark
Copy link
Member

No description provided.

Signed-off-by: ChrsMark <[email protected]>
@apmmachine
Copy link
Contributor

A docs preview will be available soon:
- HTML diff
- Observability guide

Signed-off-by: ChrsMark <[email protected]>
@ChrsMark ChrsMark changed the title [WIP] Add logs section Add logs section Oct 2, 2020
@ChrsMark
Copy link
Member Author

ChrsMark commented Oct 2, 2020

Opening this for an initial review and start a discussion about specific items. I didn't remove the initial parts' description so as to have it for reference for now until we reach to a final content. @dedemorton @masci would love your input :)

@ChrsMark ChrsMark mentioned this pull request Oct 2, 2020
@dedemorton
Copy link
Contributor

dedemorton commented Oct 2, 2020

The preview is 404ing for me. Let me try to run the doc build again

@dedemorton
Copy link
Contributor

@elasticmachine run elasticsearch-ci/docs

@dedemorton
Copy link
Contributor

@elasticmachine run elasticsearch-ci/docs rebuild

@dedemorton
Copy link
Contributor

@ChrsMark Let's discuss how you want to proceed here because we have a couple of options:

  1. Use this review to make sure the details are accurate and complete (ignoring editorial/structural/flow issues).
  2. Do a more comprehensive review before we merge this into the feature branch.

Option 1 works well for me because I start with raw content and can edit the source files directly (much easier than carpet bombing the review with 200 suggestions). I also don't have to worry as much about preserving the original author's voice.

If you choose option 2, you should remove the descriptions left over from the outline, and add proper headings/steps/formatting, where appropriate, to make the content easier to read and review.

I want to do whatever works best for you.

WDYT?

@ChrsMark
Copy link
Member Author

ChrsMark commented Oct 5, 2020

@dedemorton I'm ok with option 1. Let's ensure the content together here and then feel free to touch anything related to wording/flow etc. Is this what option 1 proposes?

@dedemorton
Copy link
Contributor

Let's ensure the content together here and then feel free to touch anything related to wording/flow etc. Is this what option 1 proposes?

@ChrsMark That's right. We just check for accuracy and completeness, then I do a full edit after the content is merged into our feature branch.

@ChrsMark
Copy link
Member Author

ChrsMark commented Oct 6, 2020

Let's ensure the content together here and then feel free to touch anything related to wording/flow etc. Is this what option 1 proposes?

@ChrsMark That's right. We just check for accuracy and completeness, then I do a full edit after the content is merged into our feature branch.

👍 Let's go with it

@dedemorton
Copy link
Contributor

@ChrsMark Looked through the content, and I think there's enough here for me to get started working. I think it will be more efficient if you just merge your two PRs into the feature branch. Then after I've done my work, we can use the PR I have open (#151) for the review. The previews will work, and we'll be able to see all the content in one place. WDYT?

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

We should go ahead and merge this in the feature branch so I can iterate on it.

@ChrsMark ChrsMark merged commit 238206d into elastic:k8s_monitoring_docs Oct 12, 2020
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