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

[DOCS] Clarify subscription requirements #58958

Merged
merged 2 commits into from
Jul 9, 2020
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 2, 2020

Related: elastic/kibana#70636
Depends on: elastic/docs#1886

This PR fixes the documentation that implies a trial licence maps to a platinum subscription. It also improves some licence-related text to align with the style guide and generally tries to avoid stating which licenses are required for specific features in the docs.

Preview

https://elasticsearch_58958.docs-preview.app.elstc.co/diff

@lcawl lcawl added :Security/License License functionality for commercial features v8.0.0 Team:Docs Meta label for docs team v7.8.1 v7.9.0 labels Jul 2, 2020
@lcawl lcawl requested a review from bytebilly July 2, 2020 21:39
@lcawl lcawl marked this pull request as ready for review July 2, 2020 21:39
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (:Security/License)

@elasticmachine elasticmachine added the Team:Security Meta label for security team label Jul 2, 2020
Copy link
Contributor

@bytebilly bytebilly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lcawl thanks for that! I left a few comments for you to consider.

@@ -16,16 +16,14 @@ This API enables you to check the status of your trial license.
[float]
==== Description

If you want to try the features that are included in a platinum license, you can
start a 30-day trial.
If you want to try all the subscription features, you can start a 30-day trial.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that subscription features is fully clear. Users may wonder which subscription it refers to, since we have multiple.

What about existing features instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the recommended term in our style guide, but I'll double-check. @chandlergibb does this seem like the appropriate usage to you?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lcawl @bytebilly subscription features seems clear enough, if we're referring to Gold/Platinum/Enterprise collectively (Basic isn't a subscription).

NOTE: You are allowed to initiate a trial only if your cluster has not
already activated a trial for the current major product version. For example, if
you have already activated a trial for v6.0, you cannot start a new trial until
v7.0. You can, however, contact `[email protected]` to request an extended trial.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a specific page where customers can automatically apply for a trial extension: https://www.elastic.co/trialextension

The page has some wording that needs to be fixed, but we're trying to standardize the process to request a trial extension and it may be better to point them to this page.

What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, I'll add that URL to our list of shared links and use it here, thanks!

@@ -16,19 +16,17 @@ This API starts a 30-day trial license.
[float]
==== Description

The `start trial` API enables you to upgrade from a basic license to a 30-day
trial license, which gives access to the platinum features.
The `start trial` API enables you to upgrade from Basic to a 30-day trial, which
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we mention Basic elsewhere before this point? Since it is the default, users may not even know that they are running a basic license.

What about to obtain a 30-day trial, or something along those lines?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I thought maybe it was implying you couldn't use this API if you had a Gold+ subscription installed, but I agree it's better to simplify this paragraph.

The `start trial` API enables you to upgrade from a basic license to a 30-day
trial license, which gives access to the platinum features.
The `start trial` API enables you to upgrade from Basic to a 30-day trial, which
gives access to all subscription features.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as before, what about existing features?

Copy link
Contributor

@bytebilly bytebilly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@lcawl lcawl merged commit 381f8d3 into elastic:master Jul 9, 2020
@lcawl lcawl deleted the licence branch July 9, 2020 15:13
lcawl added a commit to lcawl/elasticsearch that referenced this pull request Jul 9, 2020
lcawl added a commit to lcawl/elasticsearch that referenced this pull request Jul 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>enhancement :Security/License License functionality for commercial features Team:Docs Meta label for docs team Team:Security Meta label for security team v7.8.1 v7.9.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants