-
Notifications
You must be signed in to change notification settings - Fork 335
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
base: master
Are you sure you want to change the base?
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
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 if you approve I can push a commit for my suggestions |
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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
This PR adds some admonitions for serverless- and ESS-specific admonitions:
The work similar to the existing admonitions, for example:
NOTE: The rubocop config file change works around the following make error:
TBD: Are there other combinations that we'll need (e.g. "ga_all" to have a single admonition that covers all contexts)?