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 DEVELOPER_GUIDE.md, TESTING.md, etc. #943

Closed
10 of 12 tasks
ahopp opened this issue Jul 8, 2021 · 6 comments · Fixed by #946
Closed
10 of 12 tasks

[BUG] Updates needed in DEVELOPER_GUIDE.md, TESTING.md, etc. #943

ahopp opened this issue Jul 8, 2021 · 6 comments · Fixed by #946
Assignees
Labels
Beta bug Something isn't working v1.0.0 Version 1.0.0

Comments

@ahopp
Copy link

ahopp commented Jul 8, 2021

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

  • In DEVELOPER_GUIDE.md under the heading 'Project Layout', it mentions that 'docs' contains the documentation for the project. This is incorrect as that folder no longer exists.
  • In CONTRIBUTING.md, "please see OpenSearch Docs repo." points to README.md but I think it should point to here since the docs folder no longer exists.
  • The MAINTAINERS.md lists 13 maintainers and points to this file which lists 2. If there is a difference we should make it clear, if not we should should correct.
  • In TESTING.md under the heading "Testing Backwards Compatibility" it references x-pack in an example e.g. "specific tests from the x-pack rolling upgrade from 7.7.0".
  • RELEASING.md has blank/empty TODO at the bottom.
  • In TESTING.md under the heading "Testing Backwards Compatibility" it references the link to VersionCollection which is 404ing.
  • In TESTING.md under the heading "Refactor code to make it easier to test" it references an Elastic issue. We should remove or update to an OpenSearch example.
  • In TESTING.md under the heading "Test coverage analysis" it says "Test coverage reporting used to be possible with JaCoCo when OpenSearch was using Maven as its build system" but this is inaccurate. OpenSearch never used maven. This paragraph also mentions an elastic issue. I would suggest dropping the whole paragraph.
  • We lowered the requirements for Java from 14 to 11. This doc should be updated.
  • In TESTING.md under the heading "Building with extra plugins" 'opensearch-extra' should be formatted as inline code.
  • In DEVELOPER_GUIDE.md under the heading 'Project Layout', it mentions that 'plugins' contains the 'Officially supported plugins to OpenSearch' - while it might be meaningful for ODFE plugins, it's confusing for OpenSearch.
  • In client/benchmark/README.md references a document on benchmarks.elasticsearch.org.s3.amazonaws.com.

Lastly, TESTING.md references Rally - I'm not sure that OpenSearch will work with Rally and we should change this to OpenSearch Benchmarks as soon as it is released. My suggestion would be to drop the benchmarking section until OpenSearch Benchmarks is out.

To Reproduce
Open repo docs.

Expected behavior
Listed above

Plugins
N/A

Screenshots
N/A

Host/Environment (please complete the following information):

  • OS: N/A
  • Version: N/A

Additional context
None.

@ahopp ahopp added Beta bug Something isn't working untriaged labels Jul 8, 2021
@dblock
Copy link
Member

dblock commented Jul 8, 2021

@ahopp I think you almost have the diff for this :) PR?

@dblock dblock self-assigned this Jul 8, 2021
@dblock dblock added v1.0.0 Version 1.0.0 and removed untriaged labels Jul 8, 2021
@dblock
Copy link
Member

dblock commented Jul 8, 2021

I'll take this.

@mch2
Copy link
Member

mch2 commented Jul 8, 2021

@ahopp We lowered the requirements for Java from 14 to 11 only on the Main branch, this has not been backported to 1.x or 1.0.

@ahopp
Copy link
Author

ahopp commented Jul 8, 2021

I'll take this.

I appreciate it db!

@dblock
Copy link
Member

dblock commented Jul 8, 2021

Did in #946. There are a couple of open items that belong in the .github repo, I opened opensearch-project/.github#20.

@skkosuri-amzn
Copy link

Tagging: README issue: #948

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Beta bug Something isn't working v1.0.0 Version 1.0.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants