Describe the bug
There are some documentation issues that need to be addressed in the repo docs.
CONTRIBUTING.md says we're in a pre-alpha state.
CONTRIBUTING.md has a "Feature Requests" section, but doesn't link to the Feature Request Issue template.
CONTRIBUTING.md has “w00t!!!" at the very end.
PR: Removing incorrect CONTRIBUTING.md language and adding updated links #598
In /packages/osd-opensearch/README.md it references a trial/basic license (@ananzh )
PR: [Bug] Remove license concepts in packages/osd-opensearch #602
The github_checks_reporter.json file references Kibana. (@ananzh )
PR: [Bug] Remove appKey in github-checks-reporter #603
package.json has a broken link to https://www.opensearch.org/products/kibana (@ananzh )
PR: [Bug] Fix broken link in package.json #604
/packages/opensearch-eslint-config-opensearch-dashboards/package.json and README.md still references elastic and kibana (@ananzh )
PR: [Bug] Fix broken links in package.json in opensearch-eslint-config-opensearch-dashboards #605
/packages/opensearch-datemath/readme.md still references Kibana (@ananzh )
PR: [Bug] Replace words in /packages/opensearch-datemath/readme.md #606
/packages/opensearch-safer-lodash-set/LICENSE references the kibana repo (@ananzh )
PR: [Bug] Fix broken links in packages/opensearch-safter-lodash-set #607
/packages/osd-eslint-import-resolver-opensearch-dashboards/lib/get_project_root.js incorrectly references the @elastic/eslint-import-resolver-kibana package (twice)
Comment: [BUG] Updates needed in README.md, CONTRIBUTING.md, etc. #592 (comment)
Fixes formatting and typos in documentation #1697
/packages/osd-optimizer/README.md references a kibana GitHub Issue (@ananzh )
PR: [Bug] Remove kibana issue from /packages/osd-optimizer/README.md #608
Comment: [BUG] Updates needed in README.md, CONTRIBUTING.md, etc. #592 (comment)
/packages/osd-plugin-generator/README.md references "versions before OpenSearch Dashboards 6.3" which is a Kibana version. Also references the Kibana plugin template. (@ananzh )
PR: [Bug] Clean concepts in packages/osd-plugin-generator/README.md #609
/packages/osd-plugin-helpers/README.md references "versions before OpenSearch Dashboards 6.3" which is a Kibana version. Also references the Kibana plugin helpers repo. (@ananzh )
PR: [Bug] Clean concepts in packages/osd-plugin-helpers/README.md #610
/packages/osd-pm/README.md has an incorrect reference to elastic-eslint-config-kibana. (@ananzh )
PR: [Bug] Clean elastic-eslint-config-kibana in packages/osd-pm/README.md #611
/src/core/PRINCIPLES.md references Kibana (@ananzh )
PR: [Bug] replace words in PRINCIPLES.md #599
/src/core/README.md has broken links: Core Public API, Core Server API, and OpenSearch Dashboards Platform Plugin API
Comment: [BUG] Updates needed in README.md, CONTRIBUTING.md, etc. #592 (comment)
Leaving for now.
/src/core/TESTING.md references a closed Kibana PR (@ananzh )
PR: [Bug] remove incorrect reference in testing.md #597
The Dashboards README.md is missing the Logo, Code of Conduct, License, and Copyright sections
The Dashboards README.md includes a "Running tests" section.
The Dashboards README.md has a "How you can help" section.
The Dashboards README.md includes "Guiding Principles" which is duplicated from the website.
MAINTAINERS.md does not include a definition or an explanation of responsibilities.
PR: Updating MAINTAINERS.md with correct links #600
In src/core/server/saved_objects/migrations/README.md there is some very strange formatting on the 4th bullet.
Fixes formatting and typos in documentation #1697
OpenSearch-Dashboards/src/plugins/expressions/README.md links to an elastic style URL "See Canvas documentation" but is on opensearch.org
PR: [Feature] Expressions example plugin #1438
NOTICE.txt has a different format from OpenSearch's NOTICE.txt . It includes licenses from a handful of dependencies.
Issue: [BUG] Discrepancy between generated NOTICE file and the file in the repository #765
The Dashboards repo does not have a SECURITY.md file @kavilla
TYPESCRIPT.md references a GitHub issue in the "EUI component is missing types " section for a list of types in EUI but this list is out of date.
Fixes formatting and typos in documentation #1697
"Avoid any" is duplicated in TYPESCRIPT.md and DEVELOPER_GUIDE.md .
In addition, there are some open questions around telemetry to validate before resolve this two issues;
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.