[docs] Streamline beats getting started guides #17007
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dedemorton
changed the title
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
|
|
This is fantastic! You've drastically improved my very simple prototype, and turned it into something that we can actually use! I pushed some CSS changes. A few small changes, and one big change that removes the red border highlighting. Unfortunately, I was unable to make tab changes apply to all tab boxes on the page. It appears to be a bit beyond my skill level. |
bmorelli25
reviewed
May 11, 2020
bmorelli25
reviewed
May 11, 2020
bmorelli25
reviewed
May 11, 2020
|
I wonder if we could get a front-end dev to look at the CSS/HTML/JS. I'm sure there are still a lot of improvements that can be made, and they might even be able to help us sync the tabs. |
bmorelli25
reviewed
May 11, 2020
|
Adding a to-do list because there are a lot of moving parts to track: To-do list:
Work that requires Javascript/CSS help
|
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
4 tasks
EamonnTP
approved these changes
Jun 11, 2020
There was a problem hiding this comment.
@dedemorton @bmorelli25 LGTM My only comment relates to the naming of the titles. Should we use "quick start" in the titles? Some users, especially if they choose to self-manage the stack, may not find the process that quick. And also, the title "Auditbeat quick start: installation and configuration" seems a little lengthy. Maybe to be consistent with the other headings, such as "Set up and run", we could go with "Auditbeat: install and configure" or just "Install and configure"?
DanRoscigno
reviewed
Jun 11, 2020
|
@EamonnTP Thanks for your feedback
Re titles: I'll check google analytics (and look back at my notes from my meeting with Anne B). I came up with that title after meeting with Anne B to discuss the best title + URL to use for SEO. "Get started" didn't rank very highly, so we decided to drop it. I can't remember if "quick start" was necessary. I do think it's good to have some kind of signpost to tell users "start here". |
sayden
reviewed
Jun 16, 2020
sayden
reviewed
Jun 16, 2020
urso
reviewed
Jun 16, 2020
urso
reviewed
Jun 16, 2020
❕ Build Aborted
Expand to view the summary
Build stats
Test stats 🧪
Steps errorsExpand to view the steps failures
Log outputExpand to view the last 100 lines of log output
|
dedemorton
added a commit
to dedemorton/beats
that referenced
this pull request
Jun 18, 2020
* Move detail out of getting started guides * Changes in progress * Add widgets * Change tag width to 100% * remove unused css and red border * breathing room below tab content * Remove inexplicable tab Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Clean up wording * Cleanup the getting started and move some stuff * Git auditbeat building * Get all books building * More small changes * Fix build errors * Finish adding widgets and cleaning up gs guides * Fix widget filenames * More cleanup work * Add keystore tip to cloud example * Another round of improvements * Delete redundant files * Replace dashboards in quick start topics * Change short titles for quick start guides * Make shared what's next list easier to include * Remove modules quick start * More cleanup * Remove redundant files * Remove Logstash from the Winlogbeat quick start * Remove old comments * More cleanup work * Delete unused graphics * Use correct spelling for GitHub Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Add formatting Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Use correct capitalization for GitHub Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Use time filter instead of date range Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Change wording of headings as suggested during review * Add more fixes from the review * Synchronize widget tab selection and fix bugs * Include javascript only once in a file * Add script and stylesheet to support tabbed panel * Fix step numbering * Include code for displaying tabbed panel * Add javascript and css for tabbed panel * Fix code include Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co> Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
This was referenced Jun 18, 2020
12 tasks
dedemorton
removed
the
needs_backport
This was referenced Sep 1, 2020
melchiormoulin
pushed a commit
to melchiormoulin/beats
that referenced
this pull request
Oct 14, 2020
* Move detail out of getting started guides * Changes in progress * Add widgets * Change tag width to 100% * remove unused css and red border * breathing room below tab content * Remove inexplicable tab Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Clean up wording * Cleanup the getting started and move some stuff * Git auditbeat building * Get all books building * More small changes * Fix build errors * Finish adding widgets and cleaning up gs guides * Fix widget filenames * More cleanup work * Add keystore tip to cloud example * Another round of improvements * Delete redundant files * Replace dashboards in quick start topics * Change short titles for quick start guides * Make shared what's next list easier to include * Remove modules quick start * More cleanup * Remove redundant files * Remove Logstash from the Winlogbeat quick start * Remove old comments * More cleanup work * Delete unused graphics * Use correct spelling for GitHub Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Add formatting Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Use correct capitalization for GitHub Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Use time filter instead of date range Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Change wording of headings as suggested during review * Add more fixes from the review * Synchronize widget tab selection and fix bugs * Include javascript only once in a file * Add script and stylesheet to support tabbed panel * Fix step numbering * Include code for displaying tabbed panel * Add javascript and css for tabbed panel * Fix code include Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co> Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR moves extraneous content out of the Beats "getting started" topics and adds a tabbed widget for displaying platform-specific info (see NOTES below).
Preview: https://beats_17007.docs-preview.app.elstc.co/diff
This is a very big PR. To make it easier for you, I've collected a list of topics that you should view in the HTML preview (rather than the diff). Each team should review topics for the areas they own. Also look at Files Changed for other small changes that affect your area.
Rules of engagement:
AUDITBEAT
FILEBEAT
HEARTBEAT
JOURNALBEAT
METRICBEAT
PACKETBEAT
WINLOGBEAT
FUNCTIONBEAT
SHARED TOPICS
NOTES:
This PR adds a new widget for showing platform-specific content. It is a prototype and up for discussion. The widget is based on some code that @bmorelli25 came up with for an APM prototype plus some CSS changes that I made. Still needs work.