You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As brought up in this issue, to help drive adoption of OpenSearch, and improve user's experience, we're working on adding more documentation for all clients. One of the strategies mentioned in said issue is writing a collection of articles serving as a User's Guide for each client. This issue will serve as a hub for all issues related to this topic. The hub will keep track of the progress and assure that every repo has a consistent set of articles.
All articles will be written in markdown (.md) and stored in guides folder at the root of each repo.
The file names and article titles must be identical to what stated in the "Topics" section below. Each article must also include all endpoints listed (They don't have to be of the same order and other unlisted endpoints can be included if necessary).
Each code block must be explicitly delineated with the language it's written in. For example, a javascript code block must start with ```javascript instead of just ```
Pieces of code that are expected to throw errors, say you want to demonstrate that you cannot create a document of the same ID, must be wrapped in try/catch or rescue blocks. That is all code blocks in a guide must be able to be executed in order without throwing any errors.
Each article must have the following sections:
Introduction: An Overview of the Guide/Tutorial
Setup: Specify what's required before running the sample code. This should include code blocks, if any, that setup the stage. For example, article on "Document Lifecycle" should have a code block instantiating a client instance and creating an OpenSearch index.
Endpoint Sample Code: This is the meat of each article where we demonstrate how the endpoints are used for each client.
Clean Up: Remove all artifacts created by the guide.
Topics
Below is a list of topic titles, file names, link to the Ruby version of each guide, along with the endpoints that they cover.
More topics will be added over time. Feel free to suggest new topics in the comment.
@dblock regarding docs, we're already using it for method documentation in a few repos. Plus these articles will be referenced in USER_GUIDE.md as extensions to the base guide.
As brought up in this issue, to help drive adoption of OpenSearch, and improve user's experience, we're working on adding more documentation for all clients. One of the strategies mentioned in said issue is writing a collection of articles serving as a User's Guide for each client. This issue will serve as a hub for all issues related to this topic. The hub will keep track of the progress and assure that every repo has a consistent set of articles.
Conventions
.md
) and stored inguides
folder at the root of each repo.```javascript
instead of just```
try/catch
orrescue
blocks. That is all code blocks in a guide must be able to be executed in order without throwing any errors.Topics
Below is a list of topic titles, file names, link to the Ruby version of each guide, along with the endpoints that they cover.
More topics will be added over time. Feel free to suggest new topics in the comment.
The text was updated successfully, but these errors were encountered: