-
Notifications
You must be signed in to change notification settings - Fork 905
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
[BUG] Updates needed in README.md, CONTRIBUTING.md, etc. #592
Comments
I'll start with with the updates needed for CONTRIBUTING.md. |
Partially Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
Partially Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
There is kibana closed issue reference under test "authenticated / non-authenticated user access". We removed the reference in this PR. Partially Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
There is a kibana closed issue reference under test "authenticated / non-authenticated user access". We removed the reference in this PR. Partially Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
@ahopp For this issue "/src/core/README.md has broken links: Core Public API, Core Server API, and OpenSearch Dashboards Platform Plugin API", we don't have replacements for these broken links for now. Should we leave them for now? After talk to @ahopp, we all agreed to leave this issue for now. We will fix this issue once we have available links. |
Currenlty, /packages/osd-opensearch/README.md still uses trial/basic license. This PR replaces them with oss and cleans the concepts. Partially Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
github-checks-reporter is a task wrapper that provides expressive CI feedback via GitHub checks. Currently, we don’t have our own appKey. To avoid any confusions, this PR removed the old key. Partically Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
github-checks-reporter is a task wrapper that provides expressive CI feedback via GitHub checks. Currently, we don’t have our own appKey. To avoid any confusions, this PR removed the old key. Partically Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
Package.json has a broken homepage link. This PR fixes this link. Partically Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
…ensearch-dashboards /packages/opensearch-eslint-config-opensearch-dashboards/package.json has broken homepage and bug report links. This PR fixes these two links. Partically Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
/packages/opensearch-eslint-config-opensearch-dashboards/package.json has broken homepage and bug report links. This PR fixes these two links. Partically Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
Both package.json and README.md in /packages/opensearch-eslint-config-opensearch-dashboards have some broken links or old concepts. This PR fixes these two files. Partically Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
/packages/opensearch-datemath/readme.md still has old concepts. This PR replaces the word Kibana to OpenSearch Dashboards. Partically Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
Both LICENSE and package.json in packages/opensearch-safter-lodash-set have broken links. This PR fixes links in these two files. Partically Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
Both package.json and README.md in /packages/opensearch-eslint-config-opensearch-dashboards have some broken links or old concepts. This PR fixes these two files. Partically Resolved: opensearch-project#592 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
…arch-project#608) /packages/osd-optimizer/README.md has a kibana issue reference. This PR replaces the kibana issue with an open discuss issue. Partically Resolved: opensearch-project#592 Backport PR: opensearch-project#597 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
…arch-project#608) /packages/osd-optimizer/README.md has a kibana issue reference. This PR replaces the kibana issue with an open discuss issue. Partically Resolved: opensearch-project#592 Backport PR: opensearch-project#597 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
/packages/osd-optimizer/README.md has a kibana issue reference. This PR replaces the kibana issue with an open discuss issue. Partically Resolved: opensearch-project#592 Backport PR: opensearch-project#608 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
/packages/osd-optimizer/README.md has a kibana issue reference. This PR replaces the kibana issue with an open discuss issue. Partically Resolved: opensearch-project#592 Backport PR: opensearch-project#608 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
Resolves opensearch-project#592 Signed-off-by: Tommy Markley <markleyt@amazon.com>
Resolves #592 Signed-off-by: Tommy Markley <markleyt@amazon.com>
Resolves opensearch-project#592 Signed-off-by: Tommy Markley <markleyt@amazon.com>
…opensearch-project#1737) Resolves opensearch-project#592 Signed-off-by: Tommy Markley <markleyt@amazon.com> (cherry picked from commit 89d3872) Co-authored-by: Tommy Markley <markleyt@amazon.com>
…opensearch-project#1737) Resolves opensearch-project#592 Signed-off-by: Tommy Markley <markleyt@amazon.com> (cherry picked from commit 89d3872) Co-authored-by: Tommy Markley <markleyt@amazon.com>
Describe the bug
There are some documentation issues that need to be addressed in the repo docs.
PR: Removing incorrect CONTRIBUTING.md language and adding updated links #598
PR: [Bug] Remove license concepts in packages/osd-opensearch #602
PR: [Bug] Remove appKey in github-checks-reporter #603
PR: [Bug] Fix broken link in package.json #604
PR: [Bug] Fix broken links in package.json in opensearch-eslint-config-opensearch-dashboards #605
PR: [Bug] Replace words in /packages/opensearch-datemath/readme.md #606
PR: [Bug] Fix broken links in packages/opensearch-safter-lodash-set #607
Comment: [BUG] Updates needed in README.md, CONTRIBUTING.md, etc. #592 (comment)
Fixes formatting and typos in documentation #1697
PR: [Bug] Remove kibana issue from /packages/osd-optimizer/README.md #608
Comment: [BUG] Updates needed in README.md, CONTRIBUTING.md, etc. #592 (comment)
PR: [Bug] Clean concepts in packages/osd-plugin-generator/README.md #609
PR: [Bug] Clean concepts in packages/osd-plugin-helpers/README.md #610
PR: [Bug] Clean elastic-eslint-config-kibana in packages/osd-pm/README.md #611
PR: [Bug] replace words in PRINCIPLES.md #599
Comment: [BUG] Updates needed in README.md, CONTRIBUTING.md, etc. #592 (comment)
Leaving for now.
PR: [Bug] remove incorrect reference in testing.md #597
PR: Updating MAINTAINERS.md with correct links #600
Fixes formatting and typos in documentation #1697
PR: [Feature] Expressions example plugin #1438
Issue: [BUG] Discrepancy between generated NOTICE file and the file in the repository #765
Fixes formatting and typos in documentation #1697
In addition, there are some open questions around telemetry to validate before resolve this two issues;
[Response] we removed the URLs to publishing any telemetry, but the general code is still there. We did not want to remove it in case we wanted to have a replacement for it.
The text was updated successfully, but these errors were encountered: