Skip to content
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

high level serverless doc consolidation and refactoring #191

Merged
merged 37 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
5da0403
updating guidance for serverless overview
georgewallace Nov 13, 2024
168dc5e
cleaning up organization management
georgewallace Nov 14, 2024
cf51987
consolidating roles
georgewallace Nov 14, 2024
8605057
additional changes
georgewallace Nov 14, 2024
cc96ca6
combining heading
georgewallace Nov 14, 2024
73ad6b8
fixing extra heading
georgewallace Nov 14, 2024
a9dff39
reducing extra noise
georgewallace Nov 14, 2024
913f112
fixing invite instructions
georgewallace Nov 14, 2024
df7c73d
fixing image and other issues
georgewallace Nov 15, 2024
4fae609
fixing merge conflicts
georgewallace Nov 18, 2024
f99a354
fixing additional pages
georgewallace Nov 18, 2024
4be5ab5
missing discrete
georgewallace Nov 18, 2024
db22f77
correcting table
georgewallace Nov 18, 2024
faa8341
fixing offset
georgewallace Nov 18, 2024
2d93e00
updates based on feedback
georgewallace Nov 19, 2024
dd63f9a
additional updates
georgewallace Nov 19, 2024
211284f
fixing benefits
georgewallace Nov 19, 2024
1eab7ed
fixing invalid include
georgewallace Nov 19, 2024
981604a
check and organize project settings
florent-leborgne Nov 20, 2024
d2c4170
fix temp links after merge with main
florent-leborgne Nov 20, 2024
24eaba7
Update serverless/pages/project-settings-data.asciidoc
florent-leborgne Nov 20, 2024
1c38a5e
fixing toc
georgewallace Nov 20, 2024
4db0b63
fixing toc
georgewallace Nov 20, 2024
6e79505
adding applies to
georgewallace Nov 20, 2024
41f7379
fixing merge conflicts
georgewallace Nov 21, 2024
9452014
fixing index file
georgewallace Nov 21, 2024
eb8bf09
correcting index issue
georgewallace Nov 21, 2024
0c3fc48
fixing feedback
georgewallace Nov 22, 2024
cc23ddc
fixing merge issues
georgewallace Nov 22, 2024
b7718cb
updates
georgewallace Nov 22, 2024
2f00f4a
Update serverless/index-serverless-general.asciidoc
georgewallace Nov 22, 2024
1c87bc2
Apply suggestions from code review
georgewallace Nov 22, 2024
1af4900
Updates sign up page titles
KOTungseth Nov 22, 2024
7eab37d
Apply suggestions from code review
georgewallace Nov 25, 2024
21aab75
Update serverless/pages/sign-up.asciidoc
georgewallace Nov 25, 2024
1953979
Merge branch 'main' into serverless_intro_update
georgewallace Dec 2, 2024
6c712c2
Update index-serverless-general.asciidoc
georgewallace Dec 2, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified serverless/images/individual-role.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions serverless/index-serverless-devtools.asciidoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[[devtools-developer-tools]]
== Dev tools
[role="exclude",id="devtools-developer-tools"]
= Dev tools

include::./pages/general-developer-tools.asciidoc[leveloffset=+2]
include::./pages/general-developer-tools.asciidoc[leveloffset=+1]

include::./pages/run-api-requests-in-the-console.asciidoc[leveloffset=+2]
include::./pages/run-api-requests-in-the-console.asciidoc[leveloffset=+1]

include::./pages/profile-queries-and-aggregations.asciidoc[leveloffset=+2]
include::./pages/profile-queries-and-aggregations.asciidoc[leveloffset=+1]

include::./pages/debug-grok-expressions.asciidoc[leveloffset=+2]
include::./pages/debug-grok-expressions.asciidoc[leveloffset=+1]

include::./pages/debug-painless-scripts.asciidoc[leveloffset=+2]
include::./pages/debug-painless-scripts.asciidoc[leveloffset=+1]

include::./pages/developer-tools-troubleshooting.asciidoc[leveloffset=+2]
include::./pages/developer-tools-troubleshooting.asciidoc[leveloffset=+1]
11 changes: 5 additions & 6 deletions serverless/index-serverless-elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
<titleabbrev>{es}</titleabbrev>
++++

include::./pages/what-is-elasticsearch-serverless.asciidoc[leveloffset=+2]
include::./pages/serverless-differences.asciidoc[leveloffset=+2]

include::./pages/pricing.asciidoc[leveloffset=+2]

include::./pages/get-started.asciidoc[leveloffset=+2]

include::./pages/connecting-to-es-endpoint.asciidoc[leveloffset=+2]
Expand Down Expand Up @@ -42,4 +37,8 @@ include::./pages/search-your-data-semantic-search.asciidoc[leveloffset=+3]

include::./pages/explore-your-data.asciidoc[leveloffset=+2]

include::./pages/search-playground.asciidoc[leveloffset=+2]
include::./pages/search-playground.asciidoc[leveloffset=+2]

include::./pages/serverless-differences.asciidoc[leveloffset=+2]

include::./pages/pricing.asciidoc[leveloffset=+2]
25 changes: 4 additions & 21 deletions serverless/index-serverless-general.asciidoc
Original file line number Diff line number Diff line change
@@ -1,31 +1,14 @@
[[intro]]
== Welcome to {serverless-full}
== Elastic Cloud Serverless

include::{docs-content-root}/serverless/pages/welcome-to-serverless.asciidoc[leveloffset=+2]
include::./pages/welcome-to-serverless.asciidoc[leveloffset=+2]

include::./pages/what-is-serverless.asciidoc[leveloffset=+2]
include::./pages/get-started-general.asciidoc[leveloffset=+2]

include::./pages/sign-up.asciidoc[leveloffset=+2]

include::./pages/manage-org.asciidoc[leveloffset=+2]
include::./pages/manage-access-to-org.asciidoc[leveloffset=+3]
include::./pages/manage-access-to-org-user-roles.asciidoc[leveloffset=+3]
include::./pages/manage-access-to-org-from-existing-account.asciidoc[leveloffset=+3]

include::./pages/manage-your-project.asciidoc[leveloffset=+2]
include::./pages/manage-your-project-rest-api.asciidoc[leveloffset=+3]

include::./pages/manage-billing.asciidoc[leveloffset=+2]
include::./pages/manage-billing-check-subscription.asciidoc[leveloffset=+3]
include::./pages/manage-billing-monitor-usage.asciidoc[leveloffset=+3]
include::./pages/manage-billing-history.asciidoc[leveloffset=+3]
include::./pages/manage-billing-pricing-model.asciidoc[leveloffset=+3]
include::./pages/manage-billing-stop-project.asciidoc[leveloffset=+3]

include::./pages/service-status.asciidoc[leveloffset=+2]

include::./pages/user-profile.asciidoc[leveloffset=+2]

include::./pages/cloud-regions.asciidoc[leveloffset=+2]

include::./pages/ml-nlp-auto-scale.asciidoc[leveloffset=+2]

51 changes: 37 additions & 14 deletions serverless/index-serverless-project-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,27 +1,50 @@
[[project-and-management-settings]]
== Project and management settings
== Manage your project



include::./pages/project-and-management-settings.asciidoc[leveloffset=+2]

include::./pages/project-settings.asciidoc[leveloffset=+2]
include::./pages/api-keys.asciidoc[leveloffset=+3]
include::./pages/action-connectors.asciidoc[leveloffset=+3]
include::./pages/ml-nlp-auto-scale.asciidoc[leveloffset=+2]
include::./pages/manage-your-project.asciidoc[leveloffset=+2]
include::./pages/manage-your-project-rest-api.asciidoc[leveloffset=+3]

include::./index-serverless-devtools.asciidoc[leveloffset=+2]
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved

include::./pages/project-settings-access.asciidoc[leveloffset=+2]
include::./pages/manage-org.asciidoc[leveloffset=+3]
include::./pages/custom-roles.asciidoc[leveloffset=+3]
include::./pages/data-views.asciidoc[leveloffset=+3]
include::./pages/files.asciidoc[leveloffset=+3]
include::./pages/api-keys.asciidoc[leveloffset=+3]

include::./pages/project-settings-data.asciidoc[leveloffset=+2]
include::./pages/integrations.asciidoc[leveloffset=+3]
include::./pages/fleet-and-elastic-agent.asciidoc[leveloffset=+3]
include::./pages/index-management.asciidoc[leveloffset=+3]
include::./pages/data-views.asciidoc[leveloffset=+3]
include::./pages/machine-learning.asciidoc[leveloffset=+3]
include::./pages/ingest-pipelines.asciidoc[leveloffset=+3]
include::./pages/logstash-pipelines.asciidoc[leveloffset=+3]
include::./pages/machine-learning.asciidoc[leveloffset=+3]
include::./pages/maintenance-windows.asciidoc[leveloffset=+3]
include::./pages/maps.asciidoc[leveloffset=+3]
include::./pages/transforms.asciidoc[leveloffset=+3]

include::./pages/project-settings-content.asciidoc[leveloffset=+2]
include::./pages/spaces.asciidoc[leveloffset=+3]
include::./pages/reports.asciidoc[leveloffset=+3]
include::./pages/rules.asciidoc[leveloffset=+3]
include::./pages/saved-objects.asciidoc[leveloffset=+3]
include::./pages/spaces.asciidoc[leveloffset=+3]
include::./pages/files.asciidoc[leveloffset=+3]
include::./pages/maps.asciidoc[leveloffset=+3]
include::./pages/tags.asciidoc[leveloffset=+3]
include::./pages/transforms.asciidoc[leveloffset=+3]
include::./pages/visualize-library.asciidoc[leveloffset=+3]
leemthompo marked this conversation as resolved.
Show resolved Hide resolved

include::./pages/project-settings-alerts.asciidoc[leveloffset=+2]
include::./pages/rules.asciidoc[leveloffset=+3]
include::./pages/action-connectors.asciidoc[leveloffset=+3]
include::./pages/maintenance-windows.asciidoc[leveloffset=+3]

include::./pages/integrations.asciidoc[leveloffset=+2]
//include::./pages/project-settings.asciidoc[leveloffset=+2]

include::./pages/fleet-and-elastic-agent.asciidoc[leveloffset=+2]
include::./pages/manage-billing.asciidoc[leveloffset=+2]
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved
include::./pages/manage-billing-check-subscription.asciidoc[leveloffset=+3]
include::./pages/manage-billing-monitor-usage.asciidoc[leveloffset=+3]
include::./pages/manage-billing-history.asciidoc[leveloffset=+3]
include::./pages/manage-billing-pricing-model.asciidoc[leveloffset=+3]
include::./pages/manage-billing-stop-project.asciidoc[leveloffset=+3]
2 changes: 1 addition & 1 deletion serverless/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ include::./index-serverless-general.asciidoc[]
include::./index-serverless-elasticsearch.asciidoc[]
include::{observability-serverless}/index.asciidoc[]
include::{security-serverless}/index.asciidoc[]
include::./index-serverless-devtools.asciidoc[]
include::./index-serverless-project-settings.asciidoc[]

4 changes: 2 additions & 2 deletions serverless/pages/custom-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ ifdef::serverlessCustomRoles[]

This content applies to: {es-badge} {sec-badge}

The built-in <<general-assign-user-roles,organization-level roles>> and <<general-assign-user-roles,instance access roles>> are great for getting started with {serverless-full}, and for system administrators who do not need more restrictive access.
The built-in <<general-assign-user-roles-organization-level-roles,organization-level roles>> and <<general-assign-user-roles-instance-access-roles,instance access roles>> are great for getting started with {serverless-full}, and for system administrators who do not need more restrictive access.

As an administrator, however, you have the ability to create your own roles to describe exactly the kind of access your users should have within a specific project.
As an administrator, however, can create roles for users with the access they need within specific projects.
For example, you might create a marketing_user role, which you then assign to all users in your marketing department.
This role would grant access to all of the necessary data and features for this team to be successful, without granting them access they don't require.

Expand Down
2 changes: 2 additions & 0 deletions serverless/pages/explore-your-data.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ They are documented in the {es} and {kib} core documentation.
{ref}/search-aggregations.html[Aggregations]::
Use aggregations in your https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-search#operation-search-body-application-json-aggregations[`_search` API] requests to summarize your data as metrics, statistics, or other analytics.

[[elasticsearch-explore-your-data-discover-your-data]]
{kibana-ref}/discover.html[Discover]::
Use the **Discover** UI to quickly search and filter your data, get information about the structure of the fields, and display your findings in a visualization.
+
🔍 Find **Discover** in your {es-serverless} project's UI under *Analyze / Discover*.
[discrete]

[discrete]
[[elasticsearch-explore-your-data-visualizations-save-to-the-visualize-library]]
== Visualization

{kibana-ref}/dashboard.html[Dashboards]::
Expand Down
37 changes: 37 additions & 0 deletions serverless/pages/get-started-general.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[[serverless-get-started]]
= Get started

There are two options to create serverless projects:

* If you are a new user, https://cloud.elastic.co/serverless-registration[sign up for a free 14-day trial] to create a serverless project. For more information about the Elastic Cloud trials, check <<general-sign-up-trial-what-is-included-in-my-trial,Trial features>>.

* If you are an existing customer, https://cloud.elastic.co/login[log in to Elastic Cloud]. On the home page, you will see a new option to create serverless projects.

Choose the type of project that matches your needs and we'll help you get started with our solution guides.

[cols="1,1"]
|===
|
|

| image:https://www.elastic.co/docs/assets/images/elasticsearch.png[width=150]
a| [.card-title]#Elasticsearch# +
Build custom search applications with Elasticsearch.

<<what-is-elasticsearch-serverless,*View guide →*>>

| image:https://www.elastic.co/docs/assets/images/observability.png[width=150]
a| [.card-title]#Observability# +
Monitor applications and systems with Elastic Observability.

<<what-is-observability-serverless,*View guide →*>>

| image:https://www.elastic.co/docs/assets/images/security.png[width=150]
a| [.card-title]#Security# +
Detect, investigate, and respond to threats with Elastic Security.

<<what-is-security-serverless,*View guide →*>>

|
|
|===

This file was deleted.

76 changes: 0 additions & 76 deletions serverless/pages/manage-access-to-org-user-roles.asciidoc

This file was deleted.

32 changes: 0 additions & 32 deletions serverless/pages/manage-access-to-org.asciidoc

This file was deleted.

5 changes: 3 additions & 2 deletions serverless/pages/manage-billing.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
// :keywords: serverless, general, billing, overview

++++
<titleabbrev>Manage billing</titleabbrev>
<titleabbrev>Billing</titleabbrev>
++++

You can manage the billing details of your organization directly from the Elastic Cloud console.
Manage the billing details of your organization directly from the Elastic Cloud console. Bills are invoiced according to the billing contact and details that you set for your organization.

. Navigate to https://cloud.elastic.co/[cloud.elastic.co] and log in to your Elastic Cloud account.
. Go to the user icon on the header bar and select **Billing**.
Expand All @@ -22,3 +22,4 @@ From the **Billing pages**, you can perform the following tasks:
If you have a project that you're no longer using, refer to <<general-billing-stop-project,Stop charges for a project>>.

To learn about the serverless pricing model, refer to <<general-serverless-billing,Serverless billing dimensions>> and our https://www.elastic.co/pricing/serverless-search[pricing page].

Loading