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.

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

Closed
30 tasks done
ahopp opened this issue Jul 8, 2021 · 4 comments · Fixed by #1697
Closed
30 tasks done

[BUG] Updates needed in README.md, CONTRIBUTING.md, etc. #592

ahopp opened this issue Jul 8, 2021 · 4 comments · Fixed by #1697
Assignees
Labels
docs Improvements or additions to documentation technical debt If not paid, jeapardizes long-term success and maintainability of the repository.

Comments

@ahopp
Copy link
Contributor

ahopp commented Jul 8, 2021

Describe the bug
There are some documentation issues that need to be addressed in the repo docs.

In addition, there are some open questions around telemetry to validate before resolve this two issues;

  • In/packages/osd-telemetry-tools/GUIDELINE.md it references telemetry - didn't we remove that as part of the forking?
  • In OpenSearch-Dashboards/src/plugins/telemetry/README.md references telemetry and telemetry.opensearch.org. Didn't we remove this whole thing?
    [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.
@ahopp ahopp added bug Something isn't working untriaged labels Jul 8, 2021
@ahopp
Copy link
Contributor Author

ahopp commented Jul 8, 2021

I'll start with with the updates needed for CONTRIBUTING.md.

ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
Partially Resolved:
opensearch-project#592

Signed-off-by: Anan Zhuang <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
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 <[email protected]>
@kavilla kavilla removed the untriaged label Jul 8, 2021
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
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 <[email protected]>
@ananzh
Copy link
Member

ananzh commented Jul 8, 2021

@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.

ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
Package.json has a broken homepage link. This PR fixes this link.

Partically Resolved:
opensearch-project#592

Signed-off-by: Anan Zhuang <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
…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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
/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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
/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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 8, 2021
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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 12, 2021
…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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 12, 2021
…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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 12, 2021
/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 <[email protected]>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Jul 12, 2021
/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 <[email protected]>
ananzh added a commit that referenced this issue Jul 13, 2021
/packages/osd-optimizer/README.md has a kibana issue reference. This PR
replaces the kibana issue with an open discuss issue.

Partically Resolved:
#592

Backport PR:
#608

Signed-off-by: Anan Zhuang <[email protected]>
ananzh added a commit that referenced this issue Jul 13, 2021
/packages/osd-optimizer/README.md has a kibana issue reference. This PR
replaces the kibana issue with an open discuss issue.

Partically Resolved:
#592

Backport PR:
#608

Signed-off-by: Anan Zhuang <[email protected]>
@ananzh ananzh reopened this Jul 13, 2021
@tmarkley tmarkley self-assigned this Sep 8, 2021
@tmarkley tmarkley added docs Improvements or additions to documentation and removed bug Something isn't working labels May 3, 2022
@tmarkley tmarkley added the technical debt If not paid, jeapardizes long-term success and maintainability of the repository. label May 25, 2022
tmarkley pushed a commit to tmarkley/OpenSearch-Dashboards that referenced this issue Jun 8, 2022
tmarkley pushed a commit that referenced this issue Jun 13, 2022
opensearch-trigger-bot bot pushed a commit that referenced this issue Jun 13, 2022
Resolves #592

Signed-off-by: Tommy Markley <[email protected]>
(cherry picked from commit 89d3872)
opensearch-trigger-bot bot pushed a commit that referenced this issue Jun 13, 2022
Resolves #592

Signed-off-by: Tommy Markley <[email protected]>
(cherry picked from commit 89d3872)
opensearch-trigger-bot bot pushed a commit that referenced this issue Jun 13, 2022
Resolves #592

Signed-off-by: Tommy Markley <[email protected]>
(cherry picked from commit 89d3872)
opensearch-trigger-bot bot pushed a commit that referenced this issue Jun 13, 2022
Resolves #592

Signed-off-by: Tommy Markley <[email protected]>
(cherry picked from commit 89d3872)
kavilla pushed a commit that referenced this issue Jun 15, 2022
Resolves #592

Signed-off-by: Tommy Markley <[email protected]>
(cherry picked from commit 89d3872)

Co-authored-by: Tommy Markley <[email protected]>
kavilla pushed a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Jun 16, 2022
cliu123 pushed a commit to cliu123/OpenSearch-Dashboards that referenced this issue Jun 30, 2022
cliu123 pushed a commit to cliu123/OpenSearch-Dashboards that referenced this issue Jun 30, 2022
manasvinibs pushed a commit that referenced this issue Jul 7, 2022
Resolves #592

Signed-off-by: Tommy Markley <[email protected]>
(cherry picked from commit 89d3872)
kavilla added a commit that referenced this issue Aug 23, 2022
Resolves #592

Signed-off-by: Tommy Markley <[email protected]>
(cherry picked from commit 89d3872)

Co-authored-by: Tommy Markley <[email protected]>
Co-authored-by: Kawika Avilla <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation technical debt If not paid, jeapardizes long-term success and maintainability of the repository.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants