Setup documentation files #23
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>
joshuali925
approved these changes
Nov 30, 2023
sejli
reviewed
Nov 30, 2023
GETTING_STARTED_GUIDE.md
Outdated
| ] | ||
| } | ||
| ``` | ||
| 7. Create a model group with an example below (reference doc) and note the model group id. |
There was a problem hiding this comment.
Is there supposed to be a documentation reference linked where it says reference doc?
joshuali925
reviewed
Nov 30, 2023
DEVELOPER_GUIDE.md
Outdated
Comment on lines
67
to
79
| - `yarn run cypress open` | ||
|
|
||
| - Opens the Cypress test runner. | ||
|
|
||
| - `yarn run cypress run` | ||
|
|
||
| - Runs all Cypress tests headlessly in the Electron browser. | ||
|
|
||
| To run the Cypress tests, you must have both OpenSearch and OpenSearch-Dashboards running with the ML Commons plugin. | ||
|
|
||
| If you are running Cypress tests with OpenSearch-Dashboards development server, pass these 2 options to `yarn start`: | ||
| 1. `--no-base-path`: opt out the BasePathProxy. | ||
| 1. `--no-watch`: make sure your server has not restarted. |
There was a problem hiding this comment.
we haven't added cypress yet, and i think all plugins should use functional test repo instead of cypress tests inside each plugin repo so this won't work?
DEVELOPER_GUIDE.md
Outdated
|
|
||
| There are unit/stubbed integration tests and Cypress e2e/integration tests. | ||
|
|
||
| - `yarn test:jest` |
There was a problem hiding this comment.
Suggested change
| - `yarn test:jest` | |
| - `yarn test` |
DEVELOPER_GUIDE.md
Outdated
|
|
||
| 1. Download OpenSearch for the version that matches the [OpenSearch Dashboard version specified in package.json](./package.json#L9). | ||
| 1. Download and install the appropriate [OpenSearch ML Commons plugin](https://github.com/opensearch-project/ml-commons). | ||
| 1Download the OpenSearch-Dashboards source code for the [version specified in package.json](./package.json#L9) you want to set up. |
There was a problem hiding this comment.
Suggested change
| 1Download the OpenSearch-Dashboards source code for the [version specified in package.json](./package.json#L9) you want to set up. | |
| 1. Download the OpenSearch-Dashboards source code for the [version specified in package.json](./package.json) you want to set up. |
DEVELOPER_GUIDE.md
Outdated
| This codebase uses Prettier as our code formatter. All new code that is added has to be reformatted using the Prettier version listed in `package.json`. In order to keep consistent formatting across the project developers should only use the prettier CLI to reformat their code using the following command: | ||
|
|
||
| ``` | ||
| yarn prettier --write <relative file path> |
There was a problem hiding this comment.
Suggested change
| yarn prettier --write <relative file path> | |
| yarn lint --fix |
Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>
joshuali925
reviewed
Nov 30, 2023
| 3. Get log error info: Use to get information of logs with errors if the question contains an OpenSearch log index. | ||
| 4. Search Alerting Monitors By Index: Use this tool to search alerting monitors by index name in the OpenSearch cluster. | ||
| 5. Get All Alerts: Use this tool to search all alerts triggered in the OpenSearch cluster. | ||
| 6. Get ticket information: Use this tool to find tickets in the system with incidents that are relevant to a question about error causes. |
There was a problem hiding this comment.
@sejli i remember you changed this to work with documentations vector store, do you have the text/wording? it might be better than having the ticket tool here
ruanyl
reviewed
Nov 30, 2023
MAINTAINERS.md
Outdated
| | Ashish Agrawal | [lezzago](https://github.com/lezzago) | Amazon | | ||
| | Joshua Li | [joshuali925](https://github.com/joshuali925) | Amazon | | ||
| | Anirudha Jadhav | [anirudha](https://github.com/anirudha) | Amazon | | ||
| | Sean Li | [sejli](https://github.com/sejli) | Amazon | |
There was a problem hiding this comment.
Could you add Yulong Ruan, Su Zhou, Tianyu Gao, Hailong Cui, Lin Wang to the maintainers list? These will be the main maintainers of chatbot UX and agent framework integration.
ruanyl
reviewed
Nov 30, 2023
| @@ -0,0 +1,2 @@ | |||
| # This should match the owning team set up in https://github.com/orgs/opensearch-project/teams | |||
| * @lezzago @joshuali925 @anirudha @sejli | |||
There was a problem hiding this comment.
I see a warning:
Unknown owner on line 2: make sure @sejli exists and has write access to the repository
…ezzago @joshuali925 @anirudha @sejli
Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>
|
i added a setup script #30 that I've been using. Would that be helpful? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Setup documentation files such as the README, GETTING_STARTED_GUIDE, and DEVELOPER_GUIDE.
Additionally the MAINTAINERS and CODEOWNERS files have been added.
Issues Resolved
N/A
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.