Add CloudPrem quickstart #33736
Add CloudPrem quickstart #33736
Conversation
Preview links (active after the
|
janine-c
left a comment
janine-c
left a comment
There was a problem hiding this comment.
This is great! I've heard a lot of feedback that the docs can use more resources like this, where we help users achieve some quick wins. I've made some small suggestions; let me know if there's anything else I can do to help!
| url: /cloudprem/quickstart | ||
| parent: cloudprem | ||
| identifier: cloudprem_quickstart | ||
| weight: 1 |
There was a problem hiding this comment.
I'd also consider adding a link to this page: https://docs-staging.datadoghq.com/fmassot/cloudprem-quickstart/cloudprem/
content/en/cloudprem/quickstart.md
Outdated
| ## Prerequisites | ||
|
|
||
| - Ask for the [CloudPrem Preview](https://www.datadoghq.com/product-preview/cloudprem/). | ||
| - **Datadog API Key**: [Get your API key](https://app.datadoghq.com/organization-settings/api-keys). |
There was a problem hiding this comment.
For absolute beginners, we sometimes also link to this page in case they need help: http://docs.datadoghq.com/account_management/api-app-keys/#add-an-api-key-or-client-token
| ## Overview | ||
|
|
||
| In this quickstart, you will: | ||
| 1. Start CloudPrem locally using Docker. |
There was a problem hiding this comment.
I might consider making these steps anchor links down to each section; this can help users if they are, for example, particularly interested in sending a demo log. It's not a long page, though, and there's the right navigation, so I'll leave it up to you.
content/en/cloudprem/quickstart.md
Outdated
| Go to the [CloudPrem console](https://app.datadoghq.com/cloudprem) and check that your cluster is connected. You should see the `connected` status. | ||
|
|
||
| You can edit the cluster metadata and rename your cluster to `demo`. |
There was a problem hiding this comment.
| Go to the [CloudPrem console](https://app.datadoghq.com/cloudprem) and check that your cluster is connected. You should see the `connected` status. | |
| You can edit the cluster metadata and rename your cluster to `demo`. | |
| In Datadog, go to the [CloudPrem console](https://app.datadoghq.com/cloudprem) and check that your cluster is connected. You should see the `connected` status. | |
| In the CloudPrem console, you can edit the cluster metadata and rename your cluster to `demo`. |
I find that beginners can get lost when they move between things like the terminal and Datadog, so I like to over-explain where each step is to reduce that kind of confusion.
content/en/cloudprem/quickstart.md
Outdated
|
|
||
| ## Step 3: Send a log | ||
|
|
||
| Send a "Hello World" log entry directly to your local CloudPrem instance using the API: |
There was a problem hiding this comment.
| Send a "Hello World" log entry directly to your local CloudPrem instance using the API: | |
| In your terminal, send a "Hello World" log entry directly to your local CloudPrem instance using the API: |
content/en/cloudprem/quickstart.md
Outdated
| 1. Go to the [Datadog Log Explorer](https://app.datadoghq.com/logs?query=index=cloudprem-demo&storage=hot). | ||
| 2. You should see your "Hello world from CloudPrem!" log entry. |
There was a problem hiding this comment.
| 1. Go to the [Datadog Log Explorer](https://app.datadoghq.com/logs?query=index=cloudprem-demo&storage=hot). | |
| 2. You should see your "Hello world from CloudPrem!" log entry. | |
| In Datadog, go to the [Datadog Log Explorer](https://app.datadoghq.com/logs?query=index=cloudprem-demo&storage=hot). You should see your "Hello world from CloudPrem!" log entry. |
Formatting like the above where the user checked for their CloudPrem status, since "you should see..." isn't really a traditional step.
What does this PR do? What is the motivation?
Add an e2e quickstart for CloudPrem and demonstrate it can be done in less than 5 minutes.