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
Copy file name to clipboardExpand all lines: contribute-docs/api-docs/elasticsearch-api-docs-quickstart.md
+26-8Lines changed: 26 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,6 +56,31 @@ You should run `make setup` every time you begin work on a contribution, because
56
56
::::{step} Make your docs changes
57
57
Edit the relevant TypeScript files in the `specification` directory. Use JSDoc comments to describe your API interfaces, following the [guidelines](./guidelines.md). Add or update summaries, descriptions, tags, metadata, links, and examples as needed.
58
58
::::
59
+
60
+
::::{step} Format your changes
61
+
```shell
62
+
make spec-format-fix
63
+
```
64
+
Run this command to format your changes according to the standard used in the specification.
65
+
::::
66
+
67
+
::::{step} Open a pull request
68
+
69
+
Once you're satisfied with your docs changes:
70
+
1. Create a pull request from a branch on your local clone
71
+
2. Do not include generated files in the PR, including files under `output/` and `docs/examples/languageExamples.json`. CI regenerates these files, and committing them can cause backport jobs to fail.
72
+
3. The CI will generate the output and validate your additions
73
+
4. Once approved, merge your changes and ensure they are backported to the appropriate branches
74
+
::::
75
+
76
+
:::::
77
+
78
+
This is everything that is needed to contribute to the spec, as most validation is performed by CI.
79
+
If you need to preview the changes locally and check how they'll be displayed in Bump, then a few more steps are needed.
80
+
81
+
## Generate a Bump preview
82
+
83
+
:::::{stepper}
59
84
::::{step} Format, generate and validate your changes
60
85
```shell
61
86
make contrib
@@ -118,14 +143,7 @@ Run these commands to generate short-lived previews:
118
143
bump preview output/openapi/elasticsearch-openapi-docs-final.json # Preview Elasticsearch API docs
119
144
bump preview output/openapi/elasticsearch-serverless-openapi-docs-final.json # Preview Elasticsearch serverless API docs
120
145
```
121
-
::::
122
-
123
-
::::{step} Open a pull request
124
-
125
-
Once you're satisfied with your docs changes:
126
-
1. Create a pull request from a branch on your local clone
127
-
2. The CI will validate your OpenAPI specs
128
-
3. Once approved, merge your changes and ensure they are backported to the appropriate branches
146
+
After generating the previews, make sure files under `output/` and `docs/examples/languageExamples.json` are not included in your pull request. CI regenerates these files.
Copy file name to clipboardExpand all lines: deploy-manage/monitor/autoops/ec-autoops-faq.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,8 +115,8 @@ $$$maintenance$$$ **Do I have to do any maintenance when using AutoOps for ECE,
115
115
* When using the ECK installation method, make sure your instance of {{agent}} meets the [version requirements](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#prerequisites) for your license type.
116
116
117
117
$$$trial-ending$$$**I connected my ECE, ECK, or self-managed cluster to AutoOps during a free trial of {{ecloud}}. What happens after my trial ends?**
118
-
: After your free trial ends, your cluster remains connected and AutoOps continues to process your {{es}} metrics as long as:
119
-
* You have an [active {{ecloud}} account](../../cloud-organization/billing/add-billing-details.md).
118
+
: You don't need a paid {{ecloud}} subscription or an active {{ecloud}} trial to keep using AutoOps for ECE, ECK, or self-managed clusters. AutoOps is free across all [self-managed license types](https://www.elastic.co/subscriptions) through Cloud Connect. After your free trial ends, your cluster remains connected and AutoOps continues to process your {{es}} metrics as long as:
119
+
* You have an [active {{ecloud}} account](../../cloud-organization/billing/add-billing-details.md). Creating an {{ecloud}} account is free and doesn't require a paid subscription.
120
120
* {{agent}} is running and shipping metrics to {{ecloud}}.
121
121
122
122
$$$access-autoops$$$**Who has access to AutoOps in my cluster?**
Copy file name to clipboardExpand all lines: explore-analyze/discover/discover-get-started.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ This context-aware experience is determined by both your solution context and th
29
29
30
30
When you access **Discover** outside of a specific solution context, or when working with data types that don't have specialized experiences, you get the default **Discover** interface with all its core functionality for general-purpose data exploration.
31
31
32
-
{applies_to}`stack: ga 9.5` {applies_to}`serverless: ga` The active profile also shapes [AI-powered deep analysis](#analyze-with-ai): when you query logs, metrics, or traces from the matching solution context, the agent receives domain-specific guidance on which fields to group by and which {{esql}} commands to use. For example, it uses the `TS` command for time series metrics.
32
+
{applies_to}`stack: preview 9.5` {applies_to}`serverless: preview` The active profile also shapes [AI-powered deep analysis](#analyze-with-ai): when you query logs, metrics, or traces from the matching solution context, the agent receives domain-specific guidance on which fields to group by and which {{esql}} commands to use. For example, it uses the `TS` command for time series metrics.
33
33
34
34
### Context-awareness with multiple data types
35
35
@@ -398,10 +398,9 @@ To share your search and **Discover** view with a larger audience, click {icon}`
398
398
399
399
400
400
## Analyze your data with AI [analyze-with-ai]
401
-
402
401
```{applies_to}
403
-
stack: ga 9.5
404
-
serverless: ga
402
+
stack: preview 9.5
403
+
serverless: preview
405
404
```
406
405
407
406
**Discover** integrates with [{{agent-builder}}](../ai-features/elastic-agent-builder.md) to provide AI-powered analysis of your {{esql}} query results. The [`discover-data-analysis` skill](../ai-features/agent-builder/builtin-skills-reference.md#agent-builder-discover-data-analysis-skill) runs aggregation queries against the full dataset behind your current view, renders a chart for the main finding, and proposes drill-down queries you can run in a new tab.
[{{esql}} views](elasticsearch://reference/query-languages/esql/esql-views.md) aren't shown in the data source browser but they're visible through the autocomplete menu suggestions.
111
111
:::
112
112
@@ -469,7 +469,7 @@ Up to and including version 9.2, filtering for multi-value fields isn't supporte
469
469
Other interactions with the results table do not update the query, such as dragging fields onto the table or sorting the table in a specific order.
You can also have an AI agent analyze your {{esql}} results, render a chart of the main finding, and suggest drill-down queries. Refer to [Analyze your data with AI](/explore-analyze/discover/discover-get-started.md#analyze-with-ai).
474
474
:::
475
475
@@ -502,4 +502,4 @@ From the application menu, select **Switch to classic**. This only affects your
502
502
From the application menu, select **Switch to classic**.
0 commit comments