-
Notifications
You must be signed in to change notification settings - Fork 168
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
Add logs section #154
Conversation
Signed-off-by: ChrsMark <[email protected]>
A docs preview will be available soon: |
Signed-off-by: ChrsMark <[email protected]>
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 :) |
The preview is 404ing for me. Let me try to run the doc build again |
@elasticmachine run elasticsearch-ci/docs |
@elasticmachine run elasticsearch-ci/docs rebuild |
@ChrsMark Let's discuss how you want to proceed here because we have a couple of options:
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? |
@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? |
@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 |
@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? |
There was a problem hiding this 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.
No description provided.