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.
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
Update quickstart to include dashboards #6004
Update quickstart to include dashboards #6004
Changes from 41 commits
9da1e70
44a0460
f3a712f
c957ec5
727c3ea
2cfa321
4a14b21
45ca0bd
8843561
daa9d14
cbed625
7a5e749
5e92eec
07d0d9e
b3eb8fc
fbfb6f3
5362726
8d4c032
d4be24f
261fe85
16a6094
7de297f
0f32a7b
38b3d34
e029d92
33ec9c3
749bbc5
4c7a1b2
b108e98
4125309
dc05ebb
19f12b6
ae6ec77
90f36f1
0aa0247
af2a4e2
f373acc
c8f91a3
a8ff097
91d1565
95d643a
f4c63d0
06d3fc9
ddc1d1d
597b11c
5d56f43
0d6e0c2
04b1861
78e2fd5
225bcc7
e920bac
ec73dff
b8fbe95
b799add
50bc9aa
fadfe2b
111e134
15694b1
280e777
5a0f1de
6655687
efe2071
89a9c90
8db94ab
ad3ab64
b063c3c
84641e4
4bdad1e
01f1462
5fac635
2c155f1
4c70673
66df8e5
a2f44bb
26533a2
705980b
9cbe173
cd9dd8d
b33117a
3599f24
f020174
a550004
23a2770
ab83354
9da1940
f0ba91d
102b155
6428084
66827d8
d438f88
503c7d1
1015d8d
11e89d6
884baaa
453b5a8
e9d773f
fc302bc
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
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.
I'd prefer that we keep "guide" for clarity rather than using "quickstart" as a noun. Also, if this is a standalone document, should we use title case here and in the following heading?
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.
Yes to title case
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.
The organization here throws me off a little because the bullet points don't correspond to the headings that follow, and we take more of a marketing tone than I'd prefer. See my changes and let me know what you think.
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.
Thank you for the rewrites. You've tightened the writing and improved readability.
Check failure on line 18 in _dashboards/quickstart.md
GitHub Actions / vale
[vale] _dashboards/quickstart.md#L18
Raw output
Check failure on line 18 in _dashboards/quickstart.md
GitHub Actions / vale
[vale] _dashboards/quickstart.md#L18
Raw output
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.
Let's either make this its own note or combine it with the following note.
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.
I incorporated this content into the introductory sentence, with the exception of "which runs on the latest version of OpenSearch." If this information is critical, let's find a way to provide it elsewhere, perhaps in one of the notes.
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.
@natebower Your changes tighten the wording and improve readability. I accepted them.
Check failure on line 39 in _dashboards/quickstart.md
GitHub Actions / vale
[vale] _dashboards/quickstart.md#L39
Raw output
Check failure on line 59 in _dashboards/quickstart.md
GitHub Actions / vale
[vale] _dashboards/quickstart.md#L59
Raw output
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.
"permissions" instead of "access"?
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.
I would change the name of the linked page to "Analyzing data" and take a look at our word choices across the Dashboards documentation. We seem to do a lot of "exploring," "discovering," and "unlocking," when it would be better to use a word that reflects what the user will actually do.
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.
@natebower I created an issue based on this comment. #6531
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.
Do we mean "to learn more about using OpenSearch for data ingestion"?
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.
Let's replace this mockups with
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.
Replaced