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

Updates images and documents new dashboards and filters #3784

Merged
merged 17 commits into from
Sep 12, 2023

Conversation

benironside
Copy link
Contributor

@benironside benironside commented Aug 22, 2023

Fixes #3620 by updating dashboards page screenshots, and documenting the new filter functionality on the Dashboards landing page.

Previews:

Verified

This commit was signed with the committer’s verified signature.
MrAlias Tyler Yahn
@benironside benironside requested review from angorayc and a team August 22, 2023 02:13
@benironside benironside self-assigned this Aug 22, 2023
@github-actions
Copy link

Documentation previews:

Copy link
Contributor

@angorayc angorayc left a comment

Choose a reason for hiding this comment

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

Thanks so much for updating the doc @benironside ! LGTM!

benironside and others added 2 commits August 22, 2023 10:53
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
@benironside benironside requested a review from a team August 22, 2023 18:30
@mergify
Copy link
Contributor

mergify bot commented Sep 1, 2023

This pull request is now in conflicts. Could you fix it @benironside? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b 3620-8.10-dashboards-ui-updates upstream/3620-8.10-dashboards-ui-updates
git merge upstream/main
git push upstream 3620-8.10-dashboards-ui-updates

@nastasha-solomon nastasha-solomon self-requested a review September 7, 2023 03:53
Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

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

Left some super minor suggestions. Overall, LGTM!

docs/dashboards/dashboards-overview.asciidoc Outdated Show resolved Hide resolved
docs/dashboards/dashboards-overview.asciidoc Outdated Show resolved Hide resolved
docs/dashboards/dashboards-overview.asciidoc Outdated Show resolved Hide resolved
docs/dashboards/images/dashboards-landing-page.png Outdated Show resolved Hide resolved
benironside and others added 6 commits September 11, 2023 09:32
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
…elastic/security-docs into 3620-8.10-dashboards-ui-updates

test.
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

Added a few suggestions, thanks!

Let me know if you have any questions about single-sourcing the screenshot. AsciiDoc is, of course, kind of tricky with that: you can usually use the same syntax in both files (image::images/file-name.png[blah]), but the preview in VS Code might not display correctly for one of them. BUT, once you run the docs build (locally or a PR's CI), the image should display correctly on both pages.

docs/dashboards/dashboards-overview.asciidoc Outdated Show resolved Hide resolved
docs/dashboards/dashboards-overview.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

We should single-source this screenshot, so we have only one file to maintain for future UI changes. Also, the image appears really big in both pages were it's included, so I'd adjust the width syntax to about 60%.

benironside and others added 2 commits September 11, 2023 19:02
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@benironside benironside dismissed joepeeples’s stale review September 12, 2023 03:17

incorporated Joe's feedback by single-sourcing the image

@benironside benironside merged commit 051ee0d into main Sep 12, 2023
1 check passed
mergify bot pushed a commit that referenced this pull request Sep 12, 2023
* Updates images and documents new dashboards and filters

* Adds more detail, links to other resources

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* updates images for new UI

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* single-sources image

* adjust image size

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
(cherry picked from commit 051ee0d)
benironside added a commit that referenced this pull request Sep 12, 2023
* Updates images and documents new dashboards and filters

* Adds more detail, links to other resources

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>

* updates images for new UI

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update docs/dashboards/dashboards-overview.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* single-sources image

* adjust image size

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
(cherry picked from commit 051ee0d)

Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

Dashboard landing page: filters for custom dashboards
5 participants