[Metricbeat] Fix nesting of headings in Elasticsearch fields description #20676
Conversation
botelastic
bot
added
the
needs_team
sayden
added
Feature:Stack Monitoring
Team:Services
|
Pinging @elastic/stack-monitoring (Stack monitoring) |
|
Pinging @elastic/integrations-services (Team:Services) |
botelastic
bot
removed
the
needs_team
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
|
| @@ -32,127 +30,104 @@ | |||
| Total size of the store in bytes. | |||
| - name: jvm.mem.pools | |||
| type: group | |||
| description: > | |||
| JVM memory pool stats | |||
There was a problem hiding this comment.
Should these descriptions be removed? Does the doc generator break on group field descriptions?
There was a problem hiding this comment.
I reviewed this with @dedemorton
The problem is that each field that is not leaf and has a description is formatted with "Heading 1". So the only way to maintain coherence with the rest of the fields in the module is to remove the descriptions.
So the easy and fast solution is to remove description in not leaf nodes and to take a look to the fields generation script to see if it can be improved
There was a problem hiding this comment.
I see, thanks for clarifying. ++ to make these changes here as the immediate solution and then work on making the fields generation script better.
sayden
deleted the
bugfix/metricbeat/elasticsearch/node_stats/incorrect_indentation_in_docs
branch
Fixes #20575
Now all
node.statsfields are under the same "Node stats" heading