Open nhtruong opened 1 year ago
guides
is unusual, how about docs
?lifecycle
is one word@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.