[Uptime] Add first draft of uptime docs #31814

justinkambic · 2019-02-22T16:21:58Z

Summary

Add docs for Uptime user manual.

~~This is WIP.~~

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

This was checked for cross-browser compatibility, including a check against IE11
Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

elasticmachine · 2019-02-22T16:22:00Z

Pinging @elastic/kibana-docs

elasticmachine · 2019-02-22T16:22:02Z

Pinging @elastic/uptime

elasticmachine · 2019-02-22T17:03:05Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

bmorelli25

Awesome start @justinkambic !

To get this to build, you'll need to add a line to Kibana's /docs/index.asciidoc file to include the new documentation. Here's what that looks like: include::uptime/index.asciidoc[]. Once you do that, you'll be able to use the build command:

// GIT_HOME="/<fullPathTYourRepos>
$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/kibana/docs/index.x.asciidoc --chunk 1 --open

That produces around 100 build errors. No problem though, they're easy fixes! I've made the changes for you in my branch. Here's the diff. I've done three things:

Included the index file in the Kibana index file (like above) so the docs build
Added float tags to headings. Float tags tell Asciidoc that what follows isn't a "real" header and not to break it out onto its own page
Changed the IDs to be unique. IDs are the text between double square brackets: [[id-here]]. These are for linking purposes.

Once that's taken care of, see my comments below. Most of these are grammatical changes. Some are tough to decipher without the screenshots, so I'll take another look once those are ready. Note that these are suggestions. You don't have to implement everything I suggest - let's chat if you disagree!

The other thing I want to chat with you about at some point is: Why? I think this PR does a very good job of explaining the "how" and the "what" - How do I do this, what does this do, etc.. If we can work some why in as well, this'll be 🔥- Why would the snapshot view be useful, why is the status bar helpful, etc.. Sometimes this can be easily done with examples. It might make sense for us to jump on a call at some point and have you walk me through the UI. I can ask questions, and we can turn some of your answers into docs

docs/uptime/index.asciidoc

docs/uptime/overview.asciidoc

docs/uptime/monitor.asciidoc

andrewvc · 2019-03-05T21:50:39Z

@justinkambic added security docs with 90d8883

elasticmachine · 2019-03-05T22:31:44Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

andrewvc

Somewhere here we need to mention that Uptime will only work with the current major version of heartbeat. So Kibana 6.7 works with heartbeat 6.x data only.

…ime_docs

…ocs.

justinkambic · 2019-03-07T17:09:32Z

@bmorelli25 I've given some thought to your why prompt - here's my first stab at providing that: aab3a6c.

elasticmachine · 2019-03-07T17:56:13Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

bmorelli25

Nice work! I added 9751482. Please take a look and let me know your thoughts. Happy to discuss my reasoning for any or all of the changes. Also happy to revert any of them if you have a better solution. A few notes:

A couple grammar fixes
For the most part, on the monitor and overview pages, I didn't end up changing any of the text, just moved it around a bit. A lot of moving the why to the top of the sections.
I added [float] tags to the security page to keep everything on one page. Also removed "ing" from the headings and moved to sentence case
Added // CONSOLE to the security page to provide easier copying of the snippet

docs/uptime/index.asciidoc

docs/index.asciidoc

elasticmachine · 2019-03-11T23:05:38Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

bmorelli25 · 2019-03-13T20:13:52Z

9f469f2 - Moved the uptime docs under APM per Gail's advice.

@justinkambic - other than screenshots, still hoping to chat with you about this comment: https://github.com/elastic/kibana/pull/31814/files#r260515148

elasticmachine · 2019-03-13T20:59:01Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…ime_docs

elasticmachine · 2019-03-14T18:17:46Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

justinkambic · 2019-03-14T22:10:31Z

@bmorelli25 I thought I commented earlier but I can't seem to find it now. I added 7178ce3 to address your the title and content of that section.

justinkambic · 2019-03-20T21:29:09Z

@bmorelli25 we finally added some screenshots.

elasticmachine · 2019-03-21T00:32:10Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

bmorelli25

elasticmachine · 2019-03-22T16:26:30Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

* Add first draft of uptime docs. * Add first draft of uptime docs. * Implement PR feedback. * Add role info to uptime docs * Impelement some more PR feedback. * Attempt to add more copy focusing on the 'why' of each piece of the docs. * uptime docs: grammar, formatting, order * move location of uptime docs * Implement more PR feedback. * Add screenshots.

justinkambic · 2019-03-22T20:56:47Z

Backported to:

6.7 3926129
[Uptime] [Backport] Add first draft of uptime docs (#31814) #33725
7.0 52d33aa
[Uptime] [Backport] Add first draft of uptime docs (#31814) #33726
7.x 67deee1
[Uptime] [Backport] Add first draft of uptime docs (#31814) #33727

* Add first draft of uptime docs. * Add first draft of uptime docs. * Implement PR feedback. * Add role info to uptime docs * Impelement some more PR feedback. * Attempt to add more copy focusing on the 'why' of each piece of the docs. * uptime docs: grammar, formatting, order * move location of uptime docs * Implement more PR feedback. * Add screenshots.

* [Uptime] Add first draft of uptime docs (#31814) * Add first draft of uptime docs. * Add first draft of uptime docs. * Implement PR feedback. * Add role info to uptime docs * Impelement some more PR feedback. * Attempt to add more copy focusing on the 'why' of each piece of the docs. * uptime docs: grammar, formatting, order * move location of uptime docs * Implement more PR feedback. * Add screenshots. * Update snapshots.

* Add first draft of uptime docs. * Add first draft of uptime docs. * Implement PR feedback. * Add role info to uptime docs * Impelement some more PR feedback. * Attempt to add more copy focusing on the 'why' of each piece of the docs. * uptime docs: grammar, formatting, order * move location of uptime docs * Implement more PR feedback. * Add screenshots.

Add first draft of uptime docs.

fc493fd

justinkambic added Team:Docs v7.0.0 v8.0.0 Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability v6.7.0 labels Feb 22, 2019

justinkambic self-assigned this Feb 22, 2019

bmorelli25 self-requested a review February 26, 2019 19:19

justinkambic marked this pull request as ready for review February 26, 2019 21:36

bmorelli25 requested changes Feb 26, 2019

View reviewed changes

justinkambic and others added 3 commits February 28, 2019 13:20

Add first draft of uptime docs.

62bcf95

Implement PR feedback.

4bd4ac9

Add role info to uptime docs

90d8883

andrewvc mentioned this pull request Mar 7, 2019

[Uptime][META] 7.0 Punchlist #27752

Closed

7 tasks

andrewvc reviewed Mar 7, 2019

View reviewed changes

justinkambic added 4 commits March 7, 2019 11:14

Merge branch 'uptime_docs' of github.com:justinkambic/kibana into upt…

6832a7d

…ime_docs

Merge master.

f55c07d

Impelement some more PR feedback.

7851599

Attempt to add more copy focusing on the 'why' of each piece of the d…

aab3a6c

…ocs.

dov0211 mentioned this pull request Mar 7, 2019

Creation of uptime product book elastic/uptime#7

Closed

uptime docs: grammar, formatting, order

9751482

bmorelli25 reviewed Mar 11, 2019

View reviewed changes

docs/uptime/index.asciidoc Outdated Show resolved Hide resolved

docs/index.asciidoc Outdated Show resolved Hide resolved

move location of uptime docs

9f469f2

justinkambic added 2 commits March 14, 2019 13:25

Implement more PR feedback.

7178ce3

Merge branch 'uptime_docs' of github.com:justinkambic/kibana into upt…

75cb13b

…ime_docs

Add screenshots.

1bf4b5e

bmorelli25 approved these changes Mar 21, 2019

View reviewed changes

Merge branch 'master' into uptime_docs

f50d6df

justinkambic merged commit 45d2c84 into elastic:master Mar 22, 2019

justinkambic added the backport pending label Mar 22, 2019

This was referenced Mar 22, 2019

[Uptime] [Backport] Add first draft of uptime docs (#31814) #33725

Merged

[Uptime] [Backport] Add first draft of uptime docs (#31814) #33726

Merged

[Uptime] [Backport] Add first draft of uptime docs (#31814) #33727

Merged

dov0211 mentioned this pull request Apr 11, 2019

Meta - Unify uptime documentation elastic/uptime#20

Closed

5 tasks

justinkambic deleted the uptime_docs branch June 6, 2019 14:46

justinkambic removed the backport pending label Jun 6, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Uptime] Add first draft of uptime docs #31814

[Uptime] Add first draft of uptime docs #31814

justinkambic commented Feb 22, 2019 •

edited

Loading

elasticmachine commented Feb 22, 2019

elasticmachine commented Feb 22, 2019

elasticmachine commented Feb 22, 2019

bmorelli25 left a comment •

edited

Loading

andrewvc commented Mar 5, 2019

elasticmachine commented Mar 5, 2019

andrewvc left a comment

justinkambic commented Mar 7, 2019

elasticmachine commented Mar 7, 2019

bmorelli25 left a comment •

edited

Loading

elasticmachine commented Mar 11, 2019

bmorelli25 commented Mar 13, 2019

elasticmachine commented Mar 13, 2019

elasticmachine commented Mar 14, 2019

justinkambic commented Mar 14, 2019

justinkambic commented Mar 20, 2019

elasticmachine commented Mar 21, 2019

bmorelli25 left a comment

elasticmachine commented Mar 22, 2019

justinkambic commented Mar 22, 2019 •

edited

Loading

[Uptime] Add first draft of uptime docs #31814

[Uptime] Add first draft of uptime docs #31814

Conversation

justinkambic commented Feb 22, 2019 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Feb 22, 2019

elasticmachine commented Feb 22, 2019

elasticmachine commented Feb 22, 2019

💔 Build Failed

bmorelli25 left a comment • edited Loading

Choose a reason for hiding this comment

andrewvc commented Mar 5, 2019

elasticmachine commented Mar 5, 2019

💔 Build Failed

andrewvc left a comment

Choose a reason for hiding this comment

justinkambic commented Mar 7, 2019

elasticmachine commented Mar 7, 2019

💚 Build Succeeded

bmorelli25 left a comment • edited Loading

Choose a reason for hiding this comment

elasticmachine commented Mar 11, 2019

💚 Build Succeeded

bmorelli25 commented Mar 13, 2019

elasticmachine commented Mar 13, 2019

💔 Build Failed

elasticmachine commented Mar 14, 2019

💔 Build Failed

justinkambic commented Mar 14, 2019

justinkambic commented Mar 20, 2019

elasticmachine commented Mar 21, 2019

💔 Build Failed

bmorelli25 left a comment

Choose a reason for hiding this comment

elasticmachine commented Mar 22, 2019

💚 Build Succeeded

justinkambic commented Mar 22, 2019 • edited Loading

justinkambic commented Feb 22, 2019 •

edited

Loading

bmorelli25 left a comment •

edited

Loading

bmorelli25 left a comment •

edited

Loading

justinkambic commented Mar 22, 2019 •

edited

Loading