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

[DOC] Restructure Dashboards TOC #2628

Merged
merged 16 commits into from
Feb 6, 2023
Merged

[DOC] Restructure Dashboards TOC #2628

merged 16 commits into from
Feb 6, 2023

Conversation

vagimeli
Copy link
Contributor

@vagimeli vagimeli commented Feb 3, 2023

Signed-off-by: vagimeli vagimeli@amazon.com

Description

Restructures Dashboards TOC

Issues Resolved

#2621

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli vagimeli requested a review from a team as a code owner February 3, 2023 18:37
@vagimeli vagimeli self-assigned this Feb 3, 2023
@vagimeli vagimeli added backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 labels Feb 3, 2023
Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
Copy link
Contributor Author

vagimeli commented Feb 3, 2023

Proposed TOC structure

Screen Shot 2023-02-03 at 1 13 21 PM

Copy link
Contributor

@hdhalter hdhalter left a comment

Choose a reason for hiding this comment

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

Looks good, Melissa! I lean toward dropping any UI terms used in our headings. I assume we want to tie ideas to the UI but I think we can handle that in the procedures.

@@ -1,7 +1,7 @@
---
layout: default
title: Visualize
nav_order: 4
title: Building data visualizations with Visualize
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we drop 'with Visualize'?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Visualize is the application on the UI.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Screen Shot 2023-02-03 at 10 03 26 AM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hdhalter Changes made as suggested.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

TOC updates
Screen Shot 2023-02-03 at 2 58 35 PM

Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
Copy link
Contributor Author

vagimeli commented Feb 4, 2023

Thanks! I agree with you about UI. Good point.

Copy link
Contributor

@alicejw1 alicejw1 left a comment

Choose a reason for hiding this comment

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

Great work!

made a couple of minor comments

vagimeli and others added 2 commits February 6, 2023 11:50
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
Copy link
Contributor

@cwillum cwillum left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli vagimeli merged commit 6511176 into main Feb 6, 2023
@vagimeli vagimeli changed the title [DOC] Restructures Dashboards TOC [DOC] Restructure Dashboards TOC Feb 6, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.3 1.3
# Navigate to the new working tree
cd .worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-2628-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 65111760b7b9063abed5b12480722989b26eef21
# Push it to GitHub
git push --set-upstream origin backport/backport-2628-to-1.3
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-2628-to-1.3.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.0 2.0
# Navigate to the new working tree
cd .worktrees/backport-2.0
# Create a new branch
git switch --create backport/backport-2628-to-2.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 65111760b7b9063abed5b12480722989b26eef21
# Push it to GitHub
git push --set-upstream origin backport/backport-2628-to-2.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.0

Then, create a pull request where the base branch is 2.0 and the compare/head branch is backport/backport-2628-to-2.0.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.1 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.1 2.1
# Navigate to the new working tree
cd .worktrees/backport-2.1
# Create a new branch
git switch --create backport/backport-2628-to-2.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 65111760b7b9063abed5b12480722989b26eef21
# Push it to GitHub
git push --set-upstream origin backport/backport-2628-to-2.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.1

Then, create a pull request where the base branch is 2.1 and the compare/head branch is backport/backport-2628-to-2.1.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.2 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.2 2.2
# Navigate to the new working tree
cd .worktrees/backport-2.2
# Create a new branch
git switch --create backport/backport-2628-to-2.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 65111760b7b9063abed5b12480722989b26eef21
# Push it to GitHub
git push --set-upstream origin backport/backport-2628-to-2.2
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.2

Then, create a pull request where the base branch is 2.2 and the compare/head branch is backport/backport-2628-to-2.2.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.3 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.3 2.3
# Navigate to the new working tree
cd .worktrees/backport-2.3
# Create a new branch
git switch --create backport/backport-2628-to-2.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 65111760b7b9063abed5b12480722989b26eef21
# Push it to GitHub
git push --set-upstream origin backport/backport-2628-to-2.3
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.3

Then, create a pull request where the base branch is 2.3 and the compare/head branch is backport/backport-2628-to-2.3.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.4 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.4 2.4
# Navigate to the new working tree
cd .worktrees/backport-2.4
# Create a new branch
git switch --create backport/backport-2628-to-2.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 65111760b7b9063abed5b12480722989b26eef21
# Push it to GitHub
git push --set-upstream origin backport/backport-2628-to-2.4
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.4

Then, create a pull request where the base branch is 2.4 and the compare/head branch is backport/backport-2628-to-2.4.

opensearch-trigger-bot bot pushed a commit that referenced this pull request Feb 6, 2023
* Organize Dashboards TOC in logical order; copy edits for spelling and style guide compliance

Signed-off-by: vagimeli <vagimeli@amazon.com>
(cherry picked from commit 6511176)
vagimeli added a commit that referenced this pull request Feb 6, 2023
* Organize Dashboards TOC in logical order; copy edits for spelling and style guide compliance

Signed-off-by: vagimeli <vagimeli@amazon.com>
(cherry picked from commit 6511176)

Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
@vagimeli vagimeli deleted the 2621-TOC branch February 9, 2023 18:35
@vagimeli vagimeli added the Closed - Complete Issue: Work is done and associated PRs closed label Feb 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 Closed - Complete Issue: Work is done and associated PRs closed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants