Update documentation to fit mdx spec #1401
Merged
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
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
Trends 🧪 |
bmorelli25
commented
Jul 30, 2021
| @@ -62,7 +62,7 @@ | |||
| description: The kind of resource that owns this job (eg. "CronJob") | |||
| - name: is_controller | |||
| type: keyword | |||
| description: Owner is controller ("true", "false", or "<none>") | |||
| description: Owner is controller ("true", "false", or `"<none>"`) | |||
There was a problem hiding this comment.
After asking around and doing some research, I'm pretty sure I need to make this change here: https://github.com/elastic/beats/blame/master/metricbeat/module/kubernetes/state_job/_meta/fields.yml/#L75
And then do something with the import-beats script. What that something is, I'm still not sure 😅
There was a problem hiding this comment.
The import-beats script is supposed to be used only once for the initial import. Later on we apply changes only in integrations (risk of diverging between both parties is accepted).
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.
What does this PR do?
Our new documentation system doesn't support the following characters unless they're smushed inside backticks:
<,>,{, and}. This PR updates eight packages that contain syntax incompatible with mdx.I'm going to be honest, I have no idea if I can just edit
field.ymlfiles like I did -- so please let me know if I need to go about this differently. To create this PR I updated each package'sfield.ymland/or_dev/build/docs/README.mdfile, then ranelastic-package buildfollowed byelastic-package check.Checklist
changelog.ymlfile.Related issues
Closes #1400
Follow-ups
Eventually, it'd be awesome if we could add rules to automatically escape
<,>,{, and}-- similar to what I see being done in elastic/elastic-package#451.