-
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 hosts/auto-detection + K8s quick start plus overview #4073
Conversation
This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
|
8b5051b
to
a28ee20
Compare
a28ee20
to
feb2d6a
Compare
e10077d
to
eb6e91e
Compare
🚀 Built elastic-dot-co-docs-preview-docs successfully!
|
eb6e91e
to
59607d9
Compare
@dedemorton - Thanks. The draft looks good. A couple of points to consider; a) I believe that under 'Visualize your data' we will only show the call-to-action button once the script has verified that the relevant data has started flowing into ES. Maybe, it is worth mentioning or re-formulating the description accordingly. b) Under the 'Get value out of your data' section, can we briefly describe the salient points of the specific dashboards or pages that we ask the user to explore for each of the supported integrations? This a key part of the quick start flow design, as we will typically select one dashboard or feature per installed integration type. c) Should we consider a dedicated section for 'Constraints or limitations' because there will be a few for each of the new quick start flows? It might be easier to draw the attention of the user if we provide a dedicated section for this content. |
I pushed a first draft of the k8s quickstart, with relevant images. @mykolaharmash @akhileshpok CC @flash1293 |
👍 will do
Great idea! Is there a document somewhere that explains the salient points we want to add about each of the dashboards? I can probably look at the dashboards and summarize each of them, but without more guidance, I'm not sure I can add much value beyond what users can figure out by looking for themselves. If there's no existing document, maybe you or another SME can walk me through the points we want to highlight? Let me know what you think.
👍 sure it can be a dedicated section |
@akhileshpok Check out the lastest preview (linked at the top) and let me know if I'm on the right track. I may need to tweak the headings a little more, but I think we should put the details about available assets under "Visualize your data" so the section maps to what users see in the UI. Let me know what you think. cc @alaudazzi You might want to wait for feedback before applying parallel changes to your topic. |
@dedemorton Thank you for fixing it, and sorry again 🙏 |
@akhileshpok @mykolaharmash |
@akhileshpok @thomheymann I am still waiting for feedback/input to finalize this PR (specifically I need to know what we want to say about the integration assets promoted in the quickstart). See the table under "Visualize your data" in the preview. I've filled out one row as an example, but I can put whatever you feel is right. |
@alaudazzi - Can we please include this image of the flow entry point under step 3 of 'Collect your data'? Under Visualise your data, '.. the Visualize your data section provides a link to the Kubernetes Cluster Overview dashboard that can be used to monitor the health of the cluster. Further, there are links available to other useful prebuilt dashboards for Kubernetes monitoring. |
@dedemorton - In the Quickstarts overview page, probably better to state that 'Auto-detection of logs and metrics for Hosts monitoring'. Auto-detection is not available for other use cases currently. |
@abhishekbhatia1710 |
I'm not sure if I'm the appropriate reviewer for this PR. Is it possible I was tagged by mistake? Please let me know if otherwise. |
@alaudazzi - Sorry, but I still don't see the image of the entry point in Step 3. Also, can you please update the title of this section to something like, 'Monitor your Kubernetes cluster with Elastic Agent'? Further, can you please amend the last sentence in first section to, 'The kubectl command installs the standalone Elastic Agent in your Kubernetes cluster ....'. Thanks |
@dedemorton - Here are my suggestions on the the missing descriptions under the Visualize your data section for the Hosts quickstart flow. |
@akhileshpok Thanks! BTW the preview links change every time we push a new commit, so you might have been looking at an old build when you were reading Arianna's doc. I've updated the links in the summary. |
I've applied the requested changes and updated the links in the description to point to the latest build. I think we are ready for a final review! Thanks! |
@dedemorton thank you for handling the doc fixes for the k8s quickstart during my sick leave, really appreciate it. |
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.
LGTM
I'm going to merge this. If additional changes are required, please open an issue to report the change. Thanks! |
This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
|
Closes https://github.com/elastic/obs-docs-projects/issues/248
Preview links:
(1) We'll add over quickstarts to the list in the overview as they become available.
This PR includes:
Basic navigation and overview for all the quickstarts:
Topic about auto-detecting logs/metrics (host monitoring) (WIP)
TODO before merging (Host monitoring QS):
TODO after merging:
Open questions
IMO, telling users to modify the yaml config would be throwing folks into the deep end.