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.

Sign up for GitHub

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

Jump to bottom

[DOC] Revise README.md #3717

Closed
wants to merge 11 commits into from
Closed

[DOC] Revise README.md #3717

wants to merge 11 commits into from

Conversation

vagimeli
Copy link
Contributor

@vagimeli vagimeli commented Mar 28, 2023 •
edited
Loading

@joshuarrrr @kavilla @ashwin-pc Proposed changes to the Welcome section. Please let me know if we have a process for how the tech writer makes changes to content in this repo.

Description

Revise Welcome section in the README.md file

Issues Resolved

[List any issues this PR will resolve]

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
    • yarn test:ftr
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@vagimeli
Update README.md
3b91d10 
@joshuarrrr @kavilla @ashwin-pc Proposed changes to the Welcome section. Please let me know if we have a process for how the tech writer makes changes to content in this repo.
@vagimeli vagimeli requested a review from a team as a code owner March 28, 2023 17:50
@ashwin-pc
Copy link
Member

There isnt a separate process. You just need to do two things:

  1. add a signoff to the git commit git commit --amend --signoff (This adds a signature to the existing commit)
  2. Make a change to theCHANGELOG.md file and add a row under the documentation section with a link to the PR

joshuarrrr
joshuarrrr reviewed Mar 30, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@vagimeli @joshuarrrr
Update README.md
d752188 
Co-authored-by: Josh Romero <rmerqg@amazon.com>
@joshuarrrr joshuarrrr self-assigned this Apr 4, 2023
joshuarrrr and others added 8 commits April 4, 2023 13:22
@joshuarrrr @vagimeli
fix(vis_type_vega): Use default categorical color palette directly (o…
235a2b3 
…pensearch-project#3663)

rather than relying on vega.scheme. Also update vega.scheme name

Fixes opensearch-project#3582

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@pjfitzgibbons @joshuarrrr @vagimeli
Dashboard Lists Integration (opensearch-project#3090)
b8ac5d2 
* Dashboard-List Integration
* Plugins register their links with registerDashboardProvider API

Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com>

* Update CHANGELOG.md

Signed-off-by: Josh Romero <rmerqg@amazon.com>

---------

Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com>
Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: Peter Fitzgibbons <pjfitz@amazon.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@Nicksqain @ashwin-pc @vagimeli
[CCI] Fix type errors in i18n (opensearch-project#3629)
9cadb00 
* Changes related to i18n configs
* Added changes to missed commits and also added tasks Listr interface to common source
* Update imports for other files that using ListrContext interface

Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>

---------

Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>
Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@joshuarrrr @vagimeli
fix(timeline): Fix yaxis label color in dark mode (opensearch-project…
b92d878 
…#3698)

- Render label as HTML instead of in the Canvas so that it picks up text color from CSS theme
- Update CSS styles of yaxis label to match chart title
- Update HTML rendering to support custom color overrides via inline styles

Fixes opensearch-project#2250

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@ashwin-pc @vagimeli
[Fix] VisType switching persistence and selectively show warning (ope…
ba4a952 
…nsearch-project#3715)

* Refactor persistnece for simpler logic

Signed-off-by: Ashwin Pc <ashwinpc1993@gmail.com>

* renamed files

Signed-off-by: Ashwin Pc <ashwinpc1993@gmail.com>

* only show warning when dropping fields

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* delete unnecessary tests

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* addresses PR feedback

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* Fixes comparison

---------

Signed-off-by: Ashwin Pc <ashwinpc1993@gmail.com>
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@ashwin-pc @vagimeli
Add an achievement badger to the PR (opensearch-project#3721)
698810b 
* Adds achievement workflow

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* Adds changelog entry

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* Update CHANGELOG.md based on suggestion

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@ashwin-pc @vagimeli
updates PR template to hint at how to link issues to pull request (op…
f0e762f 
…ensearch-project#3730)

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@Aigerim-ai @vagimeli
add opensearch-dashboards-docker-dev to .gitignore
0c1687c 
Signed-off-by: Aigerim Suleimenova <aigerim.suleimenova27@gmail.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
@codecov-commenter
Copy link

Codecov Report

Merging #3717 (0c1687c) into main (6b42669) will not change coverage.
The diff coverage is 57.89%.

❗ Current head 0c1687c differs from pull request most recent head 0d1b473. Consider uploading reports for the commit 0d1b473 to get more accurate results

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main    #3717   +/-   ##
=======================================
  Coverage   66.43%   66.43%           
=======================================
  Files        3210     3210           
  Lines       61677    61677           
  Branches     9522     9522           
=======================================
  Hits        40977    40977           
  Misses      18419    18419           
  Partials     2281     2281
Flag Coverage Δ
Linux 66.38% <57.89%> (ø)
Windows 66.38% <57.89%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/dev/i18n/integrate_locale_files.ts 76.81% <ø> (ø)
src/plugins/dashboard/public/plugin.tsx 0.00% <0.00%> (ø)
...s_react/public/table_list_view/table_list_view.tsx 0.00% <0.00%> (ø)
...uilder/public/application/components/right_nav.tsx 8.69% <0.00%> (ø)
...plication/utils/state_management/shared_actions.ts 100.00% <ø> (ø)
...blic/application/utils/get_persisted_agg_params.ts 84.84% <84.84%> (ø)
...board/public/application/listing/create_button.tsx 91.66% <91.66%> (ø)
src/dev/i18n/utils/verify_icu_message.ts 80.00% <100.00%> (ø)
...rd/public/application/listing/dashboard_listing.js 76.92% <100.00%> (ø)
...vis_type_timeline/server/series_functions/yaxis.js 71.42% <100.00%> (ø)
... and 2 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@joshuarrrr joshuarrrr mentioned this pull request Apr 5, 2023
Closed
8 tasks
@vagimeli
Copy link
Contributor Author

vagimeli commented Apr 5, 2023

Resolved signed-off issue via #3788

@vagimeli vagimeli closed this Apr 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshuarrrr joshuarrrr joshuarrrr left review comments

Assignees

@joshuarrrr joshuarrrr

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@vagimeli @ashwin-pc @codecov-commenter @joshuarrrr @pjfitzgibbons @Nicksqain @Aigerim-ai