[Doc] Document charts plugin
#2695
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
joshuarrrr
added a commit
to joshuarrrr/OpenSearch-Dashboards
that referenced
this pull request
Oct 31, 2022
Signed-off-by: Josh Romero <[email protected]>
joshuarrrr
added a commit
to joshuarrrr/OpenSearch-Dashboards
that referenced
this pull request
Oct 31, 2022
Signed-off-by: Josh Romero <[email protected]>
joshuarrrr
force-pushed
the
docs/charts-plugin-readme-usage
branch
from
f9a05d3 to
4d8a9a7
Compare
ananzh
previously approved these changes
Oct 31, 2022
kavilla
previously approved these changes
Nov 2, 2022
ashwin-pc
reviewed
Nov 2, 2022
| @@ -0,0 +1,180 @@ | |||
| # Usage | |||
There was a problem hiding this comment.
Yeah, i'm not convinced this is the right place to have this information. Seems like the forked docsite might be a better place, but not sure how maintained that is currently.
Didnt others create similar docs on how other plugins work, e.g. How visualizations work using a flowchart. where did we share that?
One other alternative to pave the way could be to just have it here but call it something more appropriate like Current_useage.md. Developer guide is what threw me off the most. That usually means something else.
There was a problem hiding this comment.
OK, in this new revision, I've moved to the docs directory and renamed.
Didnt others create similar docs on how other plugins work, e.g. How visualizations work using a flowchart. where did we share that?
Not that I know of? I think some information like that is simply in GitHub issues, such as #2187
There was a problem hiding this comment.
I like that! That seems like a better place for high level information like this for now while we decide on the best place to consolidate this.
* Update README with full capabilities * Add `DEVELOPER_GUIDE` to track current usage Signed-off-by: Josh Romero <[email protected]>
Signed-off-by: Josh Romero <[email protected]>
- Re-order and reorganize some headers - Add issue links Signed-off-by: Josh Romero <[email protected]>
joshuarrrr
force-pushed
the
docs/charts-plugin-readme-usage
branch
from
4d8a9a7 to
c4eeb7b
Compare
ashwin-pc
approved these changes
Nov 17, 2022
abbyhu2000
approved these changes
Nov 18, 2022
ananzh
approved these changes
Nov 18, 2022
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Nov 18, 2022
- Update README with full capabilities - Add `current_usage` to track current usage Signed-off-by: Josh Romero <[email protected]> (cherry picked from commit 80cf748) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md
kavilla
pushed a commit
that referenced
this pull request
Nov 23, 2022
- Update README with full capabilities - Add `current_usage` to track current usage Signed-off-by: Josh Romero <[email protected]> (cherry picked from commit 80cf748) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AlexRuiz7
pushed a commit
to wazuh/wazuh-dashboard
that referenced
this pull request
Dec 14, 2022
- Update README with full capabilities - Add `current_usage` to track current usage Signed-off-by: Josh Romero <[email protected]>
AlexRuiz7
pushed a commit
to wazuh/wazuh-dashboard
that referenced
this pull request
Dec 14, 2022
- Update README with full capabilities - Add `current_usage` to track current usage Signed-off-by: Josh Romero <[email protected]>
sipopo
pushed a commit
to sipopo/OpenSearch-Dashboards
that referenced
this pull request
Dec 16, 2022
- Update README with full capabilities - Add `current_usage` to track current usage Signed-off-by: Josh Romero <[email protected]> Signed-off-by: Sergey Osipov <[email protected]>
Arpit-Bandejiya
pushed a commit
to Arpit-Bandejiya/OpenSearch-Dashboards
that referenced
this pull request
Jan 13, 2023
- Update README with full capabilities - Add `current_usage` to track current usage Signed-off-by: Josh Romero <[email protected]> Signed-off-by: Arpit Bandejiya <[email protected]>
sikhote
pushed a commit
to sikhote/OpenSearch-Dashboards
that referenced
this pull request
Apr 24, 2023
- Update README with full capabilities - Add `current_usage` to track current usage Signed-off-by: Josh Romero <[email protected]> Signed-off-by: David Sinclair <[email protected]>
sikhote
pushed a commit
to sikhote/OpenSearch-Dashboards
that referenced
this pull request
Apr 24, 2023
- Update README with full capabilities - Add `current_usage` to track current usage Signed-off-by: Josh Romero <[email protected]> Signed-off-by: David Sinclair <[email protected]>
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.
Description
current_usagedoc to track current usageThe primary value in documenting usage is to identify UX gaps to close as part of #2667, #2507, and #2385
Issues Resolved
fixes #2585
Check List
yarn test:jestyarn test:jest_integrationyarn test:ftr