Add Github link support to beta and experimental macros #1705
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We add the `experimental::[]` and `beta::[]` macros to document features that are not yet ready for GA. However, these tags don't currently indicate what steps are needed to get a feature to GA. With these changes, users can include a GitHub issue for the feature in the `experimental::[]` or `beta::[]`. When provided, a concise sentence and link is generated for the issue.
jrodewig
added
enhancement
nik9000
requested changes
Jan 21, 2020
|
Thanks for taking a look @nik9000. While I was rewriting this to pass the Rubocop tests, I decided to add support for |
nik9000
approved these changes
Jan 23, 2020
There was a problem hiding this comment.
I left a small thing that you can change or not. Up to you. Otherwise looks great! Thanks for doing it!
I've grown to really like rspec and find ruby to be "ok". I love rubocop. I like that it feels crazy picky coming from java-land and that it makes me think about problems differently.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We add the
experimental::[]andbeta::[]macros to document features that are not yet ready for GA. However, these tags don't currently indicate what steps are needed to get a feature to GA.With these changes, users can include a GitHub issue for the feature in the
experimental::[]orbeta::[]. When provided, a concise sentence and link is generated for the issue.Relates to https://github.com/elastic/elasticsearch/issues/51250
Examples
http://test__care-admon-links.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/_beta_experimental_macro_examples.html