Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #107 from influxdata/update/product-names 

Updated cloud names, added cloud-link shortcode
pull/115/head
Scott Anderson 2019-03-27 16:21:59 -06:00 committed by GitHub
parent c58b9f5d75 844b5cd1b4
commit b15869046d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 67 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
CONTRIBUTING.md
View File

@ -63,8 +63,8 @@ weight: # Determines sort order in both the nav tree and in article lists.
draft: # If true, will not render page on build
enterprise_all: # If true, specifies the doc as a whole is specific to InfluxDB Enterprise
enterprise_some: # If true, specifies the doc includes some content specific to InfluxDB Enterprise
cloud_all: # If true, specifies the doc as a whole is specific to InfluxCloud
cloud_some: # If true, specifies the doc includes some content specific to InfluxCloud
cloud_all: # If true, specifies the doc as a whole is specific to InfluxDB Cloud
cloud_some: # If true, specifies the doc includes some content specific to InfluxDB Cloud
v2.x/tags: # Tags specific to each version (replace .x" with the appropriate minor version )
```
@ -144,21 +144,35 @@ Insert enterprise-specific markdown content here.
#### Enterprise name
The name used to refer to InfluxData's enterprise offering is subject to change.
To facilitate easy updates in the future, use the `enterprise-name` shortcode when referencing the enterprise product.
To facilitate easy updates in the future, use the `enterprise-name` shortcode
when referencing the enterprise product.
This shortcode accepts a `"short"` parameter which uses the "short-name".
```
This is content that references {{< enterprise-name >}}.
This is content that references {{< enterprise-name "short" >}}.
```
The product name is stored in `data/products.yml`
Product names are stored in `data/products.yml`.
### InfluxCloud Content
Some articles are unique to InfluxCloud or at least contain some information specific to InfluxCloud.
#### Enterprise link
References to InfluxDB Enterprise are often accompanied with a link to a page where
visitors can get more information about the Enterprise offering.
This link is subject to change.
Use the `enterprise-link` shortcode when including links to more information about
InfluxDB Enterprise.
```
Find more info [here][{{< enterprise-link >}}]
```
### InfluxDB Cloud Content
Some articles are unique to InfluxDB Cloud or at least contain some information specific to InfluxDB Cloud.
There are frontmatter options and an cloud shortcode that help to properly identify this content.
#### All content is cloud-specific
If all content in an article is cloud-specific, set the menu in the frontmatter to `v2_0_cloud`
(change the version number for the specific version of InfluxCloud).
(change the version number for the specific version of InfluxDB Cloud).
```yaml
menu:
@ -176,7 +190,7 @@ If only some content in the article is cloud-specific, set the `cloud_some` fron
cloud_some: true
```
This will display a message at the top of page indicating some things are unique to InfluxCloud.
This will display a message at the top of page indicating some things are unique to InfluxDB Cloud.
To format cloud-specific content, wrap it in the `{{% cloud %}}` shortcode:
```md
@ -185,15 +199,29 @@ Insert Cloud-specific markdown content here.
{{% /cloud %}}
```
#### InfluxCloud name
#### InfluxDB Cloud name
The name used to refer to InfluxData's cloud offering is subject to change.
To facilitate easy updates in the future, use the `cloud-name` short-code when referencing the cloud product.
To facilitate easy updates in the future, use the `cloud-name` short-code when
referencing the cloud product.
This shortcode accepts a `"short"` parameter which uses the "short-name".
```
This is content that references {{< cloud-name >}}.
This is content that references {{< cloud-name "short" >}}.
```
The product name is stored in `data/products.yml`
Product names are stored in `data/products.yml`.
#### InfluxDB Cloud link
References to InfluxDB Cloud are often accompanied with a link to a page where
visitors can get more information.
This link is subject to change.
Use the `cloud-link` shortcode when including links to more information about
InfluxDB Cloud.
```
Find more info [here][{{< cloud-link >}}]
```
### Tabbed Content
Shortcodes are available for creating "tabbed" content (content that is changed by a users' selection).

16
content/v2.0/cloud/get-started.md
View File

@ -1,11 +1,11 @@
---
title: Get started with InfluxCloud 2.0 Beta
title: Get started with InfluxDB Cloud 2 Beta
description: >
Sign up for and get started with InfluxCloud 2.0 Beta.
Sign up for and get started with InfluxDB Cloud 2 Beta.
weight: 1
menu:
v2_0_cloud:
name: Get started with InfluxCloud
name: Get started with InfluxDB Cloud
---
{{< cloud-name >}} is a fully managed and hosted version of the InfluxDB 2.x API. To get started, complete the tasks below.
@ -17,18 +17,18 @@ The InfluxDB v2.0 alpha documentation linked to in this article also applies to
## Sign up
{{% note %}}
Early access to {{< cloud-name >}} is limited. Apply for access [here](https://www.influxdata.com/influxcloud2beta/).
Early access to {{< cloud-name >}} is limited. Apply for access [here]({{< cloud-link >}}).
{{% /note %}}
Sign up for the InfluxCloud 2.0 Beta with the link provided in the invite email.
Sign up for the {{< cloud-name >}} with the link provided in the invite email.
1. Look for an email invite from support@influxdata.com with the subject line **You've been invited to beta InfluxCloud 2.0.**
1. Look for an email invite from support@influxdata.com with the subject line **You've been invited to beta {{< cloud-name >}}.**
2. Click **Accept Invite** to begin the sign up process.
3. Provide an email id, password and follow the prompts to sign up for a Free Tier.
4. Select the Region and click Next to create your default organization and bucket.
{{% cloud-msg %}}
InfluxCloud 2.0 Beta is restricted to the us-west-2 region.
{{< cloud-name >}} is restricted to the us-west-2 region.
{{% /cloud-msg %}}
5. Once your organization and bucket are created, the usage page opens.
@ -49,7 +49,7 @@ For details, see [Automatically configure Telegraf](https://v2.docs.influxdata.c
## Query and visualize data
Once you've set up InfluxCloud to collect data with Telegraf, you can do the following:
Once you've set up {{< cloud-name "short" >}} to collect data with Telegraf, you can do the following:
* Query data using Flux, the UI, and the `influx` command line interface. See [Query data](https://v2.docs.influxdata.com/v2.0/query-data/).
* Build custom dashboards to visualize your data. See [Visualize data](https://v2.docs.influxdata.com/v2.0/visualize-data/).

2
content/v2.0/get-started.md
View File

@ -12,7 +12,7 @@ Get started with InfluxDB v2.0 by downloading InfluxDB, installing the necessary
executables, and running the initial setup process.
{{% cloud-msg %}}
This article describes how to get started with InfluxDB OSS. To get started with {{< cloud-name "short" >}}, see [Get Started with InfluxCloud 2.0 Beta](/v2.0/cloud/get-started/).
This article describes how to get started with InfluxDB OSS. To get started with {{< cloud-name "short" >}}, see [Get Started with {{< cloud-name >}}](/v2.0/cloud/get-started/).
{{% /cloud-msg %}}
{{< tabs-wrapper >}}

7
data/products.yml
View File

@ -1,8 +1,9 @@
enterprise:
name: "InfluxDB 2.0 Enterprise"
name: "InfluxDB Enterprise 2"
shortname: "InfluxDB Enterprise"
link: "#"
cloud:
name: "InfluxCloud 2.0 Beta"
shortname: "InfluxCloud"
name: "InfluxDB Cloud 2 Beta"
shortname: "InfluxDB Cloud"
link: "https://www.influxdata.com/influxcloud2beta/"

4
layouts/partials/article.html
View File

@ -8,9 +8,9 @@
{{ partial "article/tags.html" . }}
{{ if in .RelPermalink "/cloud/"}}
{{ partial "article/_cloud-feedback.html"}}
{{ partial "article/_cloud-feedback.html" . }}
{{ else }}
{{ partial "article/_alpha-feedback.html"}}
{{ partial "article/_alpha-feedback.html" . }}
{{ end }}
</article>
</div>

5
layouts/partials/article/_cloud-feedback.html
View File

@ -1,7 +1,8 @@
{{ $cloudName := .Site.Data.products.cloud.name }}
<hr/>
<div class="feedback">
<h4>InfluxCloud Bug Reports and Feedback</h4>
<h4>{{ $cloudName }} Bug Reports and Feedback</h4>
<p>
To provide feedback or report a bug, send an email to <a href="mailto:cloudbeta@influxdata.com?subject=InfluxCloud 2.0 Beta Feedback">cloudbeta@influxdata.com</a>.
To provide feedback or report a bug, send an email to <a href="mailto:cloudbeta@influxdata.com?subject={{ $cloudName }} Feedback">cloudbeta@influxdata.com</a>.
</p>
</div>

1
layouts/shortcodes/cloud-link.html Normal file
View File

@ -0,0 +1 @@
{{- .Site.Data.products.cloud.link -}}

4
layouts/shortcodes/cloud-name.html
View File

@ -1,6 +1,6 @@
{{ $length := .Get 0 | default "long" }}
{{ if eq $length "long" }}
{{- if eq $length "long" }}
{{- .Site.Data.products.cloud.name -}}
{{ else if eq $length "short" }}
{{- .Site.Data.products.cloud.shortname -}}
{{ end }}
{{ end -}}

1
layouts/shortcodes/enterprise-link.html Normal file
View File

@ -0,0 +1 @@
{{- .Site.Data.products.enterprise.link -}}

7
layouts/shortcodes/enterprise-name.html
View File

@ -1 +1,6 @@
{{ .Site.Data.products.enterprise.name }}
{{ $length := .Get 0 | default "long" }}
{{- if eq $length "long" }}
{{- .Site.Data.products.enterprise.name -}}
{{ else if eq $length "short" }}
{{- .Site.Data.products.enterprise.shortname -}}
{{ end -}}