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

Single-sourced content for cloud and cloud icon #1815

Merged
merged 8 commits into from
May 14, 2020

Conversation

nrichers
Copy link

@nrichers nrichers commented Apr 23, 2020

This PR:

  • Adds standard topics for spinning up the Elastic Stack on cloud and accessing Kibana, e.g.:

image

  • Moves the various cloud attributes into a separate section to make them easier to spot:

    image

  • Adds some standard lead-in text you can use to point people to our Elasticsearch Service (:ess-leadin: ^^)

  • Adds new cloud icons for ECE and ESS that anyone can use to indicate if something is supported on cloud

    image

The content in this PR isn't intended to be the final say, but rather to create something different books can imbed now, to be reworked over time. Some improvements we should handle in the future:

  • Add more single-sourced cloud tasks, e.g. for upgrading deployments
  • Figure out how we can source the cloud icons out of elastic/docs without requiring --resource=$GIT_HOME/docs/ for every book (or the conf.yaml equivalent)
  • If the previous bullet is addressed, to stop using the cloud icons stored on S3

Sample usage for single-sourced content is described in the source files themselves and will also be highlighted in the cloud-first writing guidelines we're working on.

@nrichers nrichers changed the title Add standard topics for Cloud trials, accessing Kibana WIP Add standard topic for setting up on cloud DO NOT REVIEW Apr 23, 2020
@nrichers nrichers changed the title WIP Add standard topic for setting up on cloud DO NOT REVIEW WIP Add standard topic for setting up on cloud Apr 23, 2020
@gtback gtback marked this pull request as draft April 23, 2020 14:38
@gtback
Copy link
Member

gtback commented Apr 23, 2020

@nrichers you can use include::{docs-root}/shared/cloud/ess-getting-started.asciidoc[] rather than traversing up and out of the current book with {asciidoc-dir}.

Like @bmorelli25 said, I think the warning about being unable to generate a header link is because the heading is in the shared file, not in the book:

source_location.path doesn't work for relative includes outside of the base_dir which we use when we build books from many repos.

I'm sure we can adapt that to work with shared-reuse snippets like this that we want to include in the main docs repo, if we decide that we want to keep the headers in the shared content, rather than everywhere that content is used.

@nrichers nrichers changed the title WIP Add standard topic for setting up on cloud Single-sourced content for cloud and cloud icon May 7, 2020
@nrichers
Copy link
Author

nrichers commented May 7, 2020

@nrichers you can use include::{docs-root}/shared/cloud/ess-getting-started.asciidoc[] rather than traversing up and out of the current book with {asciidoc-dir}.

Excellent suggestion, thank you! I changed to using {docs-root}.

Like @bmorelli25 said, I think the warning about being unable to generate a header link is because the heading is in the shared file, not in the book

It turned out to be caused by my use of a delimited block, which could cause issues if you were already inside of one when imbedding the file or if you were inside a partintro. (Moral of the story: keep things as simple as possible.)

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

Tested the piece I need, and it LGTM

shared/attributes.asciidoc Show resolved Hide resolved
Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

LGTM

@nrichers nrichers marked this pull request as ready for review May 14, 2020 20:15
@nrichers nrichers added the docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo. label May 14, 2020
@nrichers nrichers merged commit e6148b4 into elastic:master May 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants