-
Notifications
You must be signed in to change notification settings - Fork 181
[ON week] review and fix Vale checks corrected by Cursor #3878
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
base: main
Are you sure you want to change the base?
Conversation
🔍 Preview links for changed docs |
shainaraskas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
couple spot checks
|
|
||
| * Create, read, update, and delete documents. | ||
| * Perform everything from simple keyword searches to complex analytical aggregations. | ||
| * Create, read, update, and remove documents. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to keep delete in cases like this because it reflects CRUD ops
| * Create, read, update, and delete documents. | ||
| * Perform everything from simple keyword searches to complex analytical aggregations. | ||
| * Create, read, update, and remove documents. | ||
| * Perform everything from efficient keyword searches to complex analytical aggregations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
simple is accurate here (reflects actual search complexity, rather than a judgement on how complex it is for a user to execute on)
| * The APIs provide direct access to the core capabilities of Elasticsearch and Kibana. If you can do it in the UI, you can automate it with the API. | ||
| * Elastic provides and supports official [clients](/reference/elasticsearch-clients/index.md) for popular languages like Java, Go, .NET, PHP, Python, Ruby, and JavaScript. These clients simplify interacting with the API, handling requests, and processing responses. | ||
| * The APIs are secured using role-based access control (RBAC). You can create API keys or use bearer tokens with fine-grained permissions to ensure your interactions are safe. | ||
| * Role-based access control (RBAC) secures the APIs. You can create API keys or use bearer tokens with fine-grained permissions to ensure your interactions are safe. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the grammar of the original sentence is more clear imo - this is a good case for passive voice
| This approach is ideal for shipping data, logs, metrics, and traces. By building an integration, you contribute to the ever-growing ecosystem that both you and the community can benefit from. | ||
|
|
||
| * Integrations are built on a consistent framework, providing users with a turnkey experience, including dashboards, visualizations, and alerts. | ||
| * We build integrations on a consistent framework, providing users with a turnkey experience, including dashboards, visualizations, and alerts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"we" is not right here. it indicates that integrations provide consistency by leveraging a framework, but integrations aren't always built by "us" - that's why we have an extensibility guide for it
No description provided.