-
Notifications
You must be signed in to change notification settings - Fork 25.6k
[DOCS] Remove [testenv="gold+"] attributes
#79309
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
Conversation
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-delivery (Team:Delivery) |
|
Thanks @edh-oss. This looks great!
I pushed a commit to remove the I also removed |
|
@elasticmachine ok to test |
|
Apologies for the extra commits and noise. I initially removed some Thanks again @edh-oss. |
|
@elasticmachine update branch |
|
@elasticmachine update branch |
|
@elasticmachine update branch |
|
@elasticmachine run elasticsearch-ci/part-2 |
[testenv="gold+"]
[testenv="gold+"][testenv="gold+"] attributes
Changes: * Removes several `[testenv="gold+"]` attributes from the docs. `gold+` is not a valid [subscription level](https://www.elastic.co/subscriptions) or testenv value. * Moves two `[testenv="basic"]` attributes to the file header. This makes the `testenv` placement consistent and fixes the yml file generated from `docs/reference/snapshot-restore/register-repository.asciidoc`. Co-authored-by: James Rodewig <[email protected]> Co-authored-by: edh-oss <[email protected]>
Changes: * Removes several `[testenv="gold+"]` attributes from the docs. `gold+` is not a valid [subscription level](https://www.elastic.co/subscriptions) or testenv value. * Moves two `[testenv="basic"]` attributes to the file header. This makes the `testenv` placement consistent and fixes the yml file generated from `docs/reference/snapshot-restore/register-repository.asciidoc`. Co-authored-by: James Rodewig <[email protected]> Co-authored-by: edh-oss <[email protected]>
Changes: * Removes several `[testenv="gold+"]` attributes from the docs. `gold+` is not a valid [subscription level](https://www.elastic.co/subscriptions) or testenv value. * Moves two `[testenv="basic"]` attributes to the file header. This makes the `testenv` placement consistent and fixes the yml file generated from `docs/reference/snapshot-restore/register-repository.asciidoc`. Co-authored-by: James Rodewig <[email protected]> Co-authored-by: edh-oss <[email protected]> Co-authored-by: Elastic Machine <[email protected]>
…80459) Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible. Relates to #79309, #31619 # Conflicts: # docs/reference/ingest/range-enrich-policy-type-ex.asciidoc # docs/reference/migration/apis/feature_upgrade.asciidoc # docs/reference/ml/df-analytics/apis/get-trained-model-deployment-stats.asciidoc # docs/reference/ml/df-analytics/apis/infer-trained-model-deployment.asciidoc # docs/reference/ml/df-analytics/apis/put-trained-model-definition-part.asciidoc # docs/reference/ml/df-analytics/apis/put-trained-model-vocabulary.asciidoc # docs/reference/ml/df-analytics/apis/start-trained-model-deployment.asciidoc # docs/reference/ml/df-analytics/apis/stop-trained-model-deployment.asciidoc # docs/reference/slm/apis/slm-delete.asciidoc # docs/reference/slm/apis/slm-execute-retention.asciidoc # docs/reference/slm/apis/slm-execute.asciidoc # docs/reference/slm/apis/slm-get-status.asciidoc # docs/reference/slm/apis/slm-get.asciidoc # docs/reference/slm/apis/slm-start.asciidoc # docs/reference/slm/apis/slm-stats.asciidoc # docs/reference/slm/apis/slm-stop.asciidoc # docs/reference/sql/endpoints/client-apps/tableau-desktop.asciidoc # docs/reference/sql/endpoints/client-apps/tableau-server.asciidoc # docs/reference/transform/apis/upgrade-transforms.asciidoc
…80458) Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible. Relates to #79309, #31619 # Conflicts: # docs/reference/ml/df-analytics/apis/get-trained-model-deployment-stats.asciidoc # docs/reference/ml/df-analytics/apis/infer-trained-model-deployment.asciidoc # docs/reference/ml/df-analytics/apis/put-trained-model-definition-part.asciidoc # docs/reference/ml/df-analytics/apis/put-trained-model-vocabulary.asciidoc # docs/reference/ml/df-analytics/apis/start-trained-model-deployment.asciidoc # docs/reference/ml/df-analytics/apis/stop-trained-model-deployment.asciidoc # docs/reference/slm/apis/slm-delete.asciidoc # docs/reference/slm/apis/slm-execute-retention.asciidoc # docs/reference/slm/apis/slm-execute.asciidoc # docs/reference/slm/apis/slm-get-status.asciidoc # docs/reference/slm/apis/slm-get.asciidoc # docs/reference/slm/apis/slm-start.asciidoc # docs/reference/slm/apis/slm-stats.asciidoc # docs/reference/slm/apis/slm-stop.asciidoc # docs/reference/sql/endpoints/client-apps/tableau-desktop.asciidoc # docs/reference/sql/endpoints/client-apps/tableau-server.asciidoc
Changes:
[testenv="gold+"]attributes from the docs.gold+is not a valid subscription level or testenv value.[testenv="basic"]attributes to the file header. This makes thetestenvplacement consistent and fixes the yml file generated fromdocs/reference/snapshot-restore/register-repository.asciidoc.Original text
This PR is doing three things:
Current code in RestTestsFromSnippetsTask allows for testenv to have one of four values: basic, gold, platinum or enterprise. In the asciidoc files, five are in use. The fifth is "gold+", which appears in eight files under "docs/reference/commands". None of those eight files contains a test snippet, so the value of testenv is never checked and never used. If any of them were to contain a test snippet, an exception would result. This PR assumes that "gold+" actually is a valid value for testenv, and updates RestTestsFromSnippetsTask accordingly.
There are 332 asciidoc files that set the testenv attribute. 328 of them put that statement in the doc header. I've updated the other four. For three of the four, the generated yaml is unchanged. The fourth of those files is register-repository.asciidoc.
In register-repository.asciidoc, the testenv attribute is set between the first test snippet and a series of corresponding "TEST[continued]" snippets. This placement means that, at least for the purposes of yaml generation, setting the attribute does nothing. If it's set at the top of the file, in the document header, then "xpack" is added to each snippets' list of skipped features. I believe the latter to be the expected behavior, and this CR makes the corresponding update.