fixes#706condensed-header #760
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
Signed-off-by: cwillum <cwmmoore@amazon.com>
cwillum
added
v2.1.0
3 - Tech review
kolchfa-aws
reviewed
Jul 6, 2022
| @@ -35,6 +35,8 @@ loadingLogo | Loading logo used when OpenSearch Dashboards is starting. See #3 i | |||
| faviconUrl | Website icon. Loads next to the application title. See #4 in the image. | |||
| applicationTitle | The application's title. See #5 in the image. | |||
|
|
|||
| **Note** --- To consolidate navigation controls and reduce the space the header takes up on the page, see [Condensed header](#condensed-header). | |||
|
|
|||
There was a problem hiding this comment.
For notes, you can use the Markdown {: .note } marker. Example:
This is a note.
{: .note }
Naarcha-AWS
approved these changes
Jul 6, 2022
_dashboards/branding.md
Outdated
| useExpandedHeader: false | ||
| ``` | ||
|
|
||
| **Note:** --- In a future release, default behavior will become `useExpandedHeader: false`. If you want to retain the default view in subsequent releases, you can explicitly set the property to `true` in advance. You can also wait to do this when upgrading. |
There was a problem hiding this comment.
See @kolchfa-aws comment on notes.
|
Looks good besides a quick fix from @kolchfa-aws. |
kolchfa-aws
approved these changes
Jul 6, 2022
cwillum
added
5 - Editorial review
Signed-off-by: cwillum <cwmmoore@amazon.com>
natebower
reviewed
Jul 6, 2022
_dashboards/branding.md
Outdated
| In a future release, default behavior will become `useExpandedHeader: false`. If you want to retain the default view in subsequent releases, you can explicitly set the property to `true` in advance. You can also wait to do this when upgrading. | ||
| {: .note } | ||
|
|
||
| The condensed view header appears as in the example here. |
There was a problem hiding this comment.
Instead of "here", can we use "below"?
_dashboards/branding.md
Outdated
| useExpandedHeader: false | ||
| ``` | ||
|
|
||
| In a future release, default behavior will become `useExpandedHeader: false`. If you want to retain the default view in subsequent releases, you can explicitly set the property to `true` in advance. You can also wait to do this when upgrading. |
There was a problem hiding this comment.
Last sentence: Would any meaning be lost if we just said "You can also do this when upgrading"? Otherwise, I would replace "to" with "and".
_dashboards/branding.md
Outdated
|
|
||
| Header element | Description | ||
| :--- | :--- | ||
| Home button | See #1. Returns to home page and provides an indication when a page is loading. |
There was a problem hiding this comment.
Insert "the" before "home page".
_dashboards/branding.md
Outdated
| OpenSearch logo | See #1. Functions as the home button. | ||
| Header bar | See #2. A single header bar used for all navigation controls. | ||
|
|
||
| The default view remains close to the traditional view with minor changes. |
There was a problem hiding this comment.
Insert a comma after the second instance of "view".
_dashboards/branding.md
Outdated
| Header label | See #2. The label also functions as a home button. | ||
| Navigation controls | See #3. Additional navigation controls on right-side insertion points. | ||
|
|
||
| #### Preserving nagivation elements in default view |
There was a problem hiding this comment.
Should we consistently use "the default view" as opposed to using just "default view" here?
_dashboards/branding.md
Outdated
|
|
||
| #### Preserving nagivation elements in default view | ||
|
|
||
| You can continue using the top header bar in the default view for custom navigation links (such as menu items and plugins). Follow the steps below to keep these elements in the top header in default view. |
There was a problem hiding this comment.
Second sentence: same comment re: "the default view".
Signed-off-by: cwillum <cwmmoore@amazon.com>
|
@natebower I've incorporated all of your suggestions. Thanks. |
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jul 6, 2022
Signed-off-by: cwillum <cwmmoore@amazon.com> (cherry picked from commit 2f0d107)
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jul 6, 2022
Signed-off-by: cwillum <cwmmoore@amazon.com> (cherry picked from commit 2f0d107)
cwillum
pushed a commit
that referenced
this pull request
Jul 6, 2022
cwillum
added a commit
that referenced
this pull request
Jul 6, 2022
Naarcha-AWS
added
backport 2.1
and removed
backport 1.3
|
The backport to 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-760-to-2.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 2f0d1074de20f8b5469d0250371870f7d237fc57
# Push it to GitHub
git push --set-upstream origin backport/backport-760-to-2.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.1Then, create a pull request where the |
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.
Fixes #706
@joshuarrrr Hi Joshua, could you have a look at the additions I made here and make sure I captured everything we need to have? Also, will this backport to 1.3 and 2.0? Thanks.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.