From e4808c26d4a2bedbe4cc5ecb191ab43f6e894164 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Mon, 28 Oct 2024 14:28:57 +0100 Subject: [PATCH 1/3] Fix bugs in ES3 get started --- serverless/pages/get-started.mdx | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/serverless/pages/get-started.mdx b/serverless/pages/get-started.mdx index 4bcf577e07..49cf6904e7 100644 --- a/serverless/pages/get-started.mdx +++ b/serverless/pages/get-started.mdx @@ -17,7 +17,7 @@ Use your ((ecloud)) account to create a fully-managed ((es)) project: 1. Navigate to [cloud.elastic.co](((ess-console))) and create a new account or log in to your existing account. -1. Within **Fully-managed projects**, choose **Create project**. +1. Within **Serverless Projects**, choose **Create project**. 1. Choose the ((es)) project type. @@ -40,13 +40,17 @@ Create an API key, which will enable you to access the ((es)) API to ingest and 1. Scroll to **Add an API Key** and select **New**. -1. In **Create an API key**, enter a name for your key and its expiration. - Select **Create API Key** to finish. - -The API key is displayed as a set of values, including `id`, `name`, `expiration`, `api_key`, and `encoded`. -Store this information securely—it is displayed only once. - -You will use the `encoded` value when sending API requests. +1. In **Create API Key**, enter a name for your key and its expiration. + +1. Under **Control Security privileges**, you can set specific access permissions for this API key. By default, it has full access to all APIs. + +1. The **Add metadata** section allows you to add custom key-value pairs to help identify and organize your API keys. + +1. Select **Create API Key** to finish. + +After creation, you'll see your API key displayed as an encoded string. +Store this encoded API key securely—it is displayed only once and cannot be retrieved later. +You will use this encoded API key when sending API requests. You can't recover or retrieve a lost API key. Instead, you must delete the key and create a new one. From 2cee61544bd501f0f3439621d2cafe36f7c4e766 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Mon, 28 Oct 2024 14:30:16 +0100 Subject: [PATCH 2/3] Del whitespace --- serverless/pages/get-started.mdx | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/serverless/pages/get-started.mdx b/serverless/pages/get-started.mdx index 49cf6904e7..685835e88e 100644 --- a/serverless/pages/get-started.mdx +++ b/serverless/pages/get-started.mdx @@ -16,18 +16,13 @@ Then, choose how to continue with your own data. Use your ((ecloud)) account to create a fully-managed ((es)) project: 1. Navigate to [cloud.elastic.co](((ess-console))) and create a new account or log in to your existing account. - 1. Within **Serverless Projects**, choose **Create project**. - 1. Choose the ((es)) project type. - 1. Select a **configuration** for your project, based on your use case. - **General purpose**. For general search use cases across various data types. - **Optimized for Vectors**. For search use cases using vectors and near real-time retrieval. - 1. Provide a name for the project and optionally edit the project settings, such as the cloud platform . Select **Create project** to continue. - 1. Once the project is ready, select **Continue**. You should now see **Get started with ((es))**, and you're ready to continue. @@ -39,13 +34,9 @@ You should now see **Get started with ((es))**, and you're ready to continue. Create an API key, which will enable you to access the ((es)) API to ingest and search data. 1. Scroll to **Add an API Key** and select **New**. - 1. In **Create API Key**, enter a name for your key and its expiration. - 1. Under **Control Security privileges**, you can set specific access permissions for this API key. By default, it has full access to all APIs. - 1. The **Add metadata** section allows you to add custom key-value pairs to help identify and organize your API keys. - 1. Select **Create API Key** to finish. After creation, you'll see your API key displayed as an encoded string. @@ -62,7 +53,6 @@ Next, copy the URL of your API endpoint. You'll send all ((es)) API requests to this URL. 1. Scroll to **Copy your connection details**. - 1. Find the value for **Elasticsearch Endpoint**. Store this value along with your `encoded` API key. From 3ec9e7d37b74b8de4fcab26147bb4b04016a21e4 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Mon, 28 Oct 2024 14:38:36 +0100 Subject: [PATCH 3/3] Clarify optional steps --- serverless/pages/get-started.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/serverless/pages/get-started.mdx b/serverless/pages/get-started.mdx index 685835e88e..e9ce283ed4 100644 --- a/serverless/pages/get-started.mdx +++ b/serverless/pages/get-started.mdx @@ -34,13 +34,13 @@ You should now see **Get started with ((es))**, and you're ready to continue. Create an API key, which will enable you to access the ((es)) API to ingest and search data. 1. Scroll to **Add an API Key** and select **New**. -1. In **Create API Key**, enter a name for your key and its expiration. -1. Under **Control Security privileges**, you can set specific access permissions for this API key. By default, it has full access to all APIs. -1. The **Add metadata** section allows you to add custom key-value pairs to help identify and organize your API keys. +1. In **Create API Key**, enter a name for your key and (optionally) set an expiration date. +1. (Optional) Under **Control Security privileges**, you can set specific access permissions for this API key. By default, it has full access to all APIs. +1. (Optional) The **Add metadata** section allows you to add custom key-value pairs to help identify and organize your API keys. 1. Select **Create API Key** to finish. After creation, you'll see your API key displayed as an encoded string. -Store this encoded API key securely—it is displayed only once and cannot be retrieved later. +Store this encoded API key securely. It is displayed only once and cannot be retrieved later. You will use this encoded API key when sending API requests.