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

Draft some new admonitions #3085

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Draft some new admonitions #3085

wants to merge 2 commits into from

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Oct 10, 2024

This PR adds some admonitions for serverless- and ESS-specific admonitions:

  • beta_ess
  • beta_serverless
  • dev_ess
  • dev_serverless
  • ga_serverless
  • ga_stack
  • ga_ess
  • deprecated_ess
  • deprecated_serverless
  • discontinued_ess
  • discontinued_serverless
  • discontinued_stack
  • coming_ess
  • coming_serverless

The work similar to the existing admonitions, for example:

image

NOTE: The rubocop config file change works around the following make error:

lib/care_admonition/extension.rb:100:3: C: Metrics/MethodLength: Method has too many lines. [31/20]

TBD: Are there other combinations that we'll need (e.g. "ga_all" to have a single admonition that covers all contexts)?

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@lcawl lcawl marked this pull request as ready for review November 7, 2024 15:10
@lcawl lcawl requested a review from a team as a code owner November 7, 2024 15:10
@leemthompo
Copy link
Contributor

  • I'd like a simple "Not available on serverless" tag too :)
  • I guess we should s/Elastic Serverless/Elastic Cloud Serverless/g

@leemthompo
Copy link
Contributor

@lcawl if you approve I can push a commit for my suggestions

Comment on lines +75 to +86
DEPRECATED_ESS_TEXT = <<~TEXT.strip
This functionality is deprecated in Elasticsearch Service and will be removed in a future release.
TEXT
DEPRECATED_SERVERLESS_TEXT = <<~TEXT.strip
This functionality is deprecated in Elastic Cloud Serverless and will be removed in a future release.
TEXT
DISCONTINUED_ESS_TEXT = <<~TEXT.strip
This functionality is discontinued in Elasticsearch Service.
TEXT
DISCONTINUED_SERVERLESS_TEXT = <<~TEXT.strip
This functionality is discontinued in Elastic Cloud Serverless.
TEXT
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the difference between deprecated and discontinued? Can we make the discontinued description more specific?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We haven't had "discontinued" before but it arose in discussions like elastic/kibana#192292. Currently we just remove content when the pertinent feature goes from "deprecated" to discontinued/removed/no longer available. If our pages span multiple versions, however, or if we want to give folks a clear indication of when a feature will be removed, it seems like this might be something we'll want to have a way of calling out.

@lcawl lcawl enabled auto-merge (squash) November 14, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants