Change: GMP doc: add boxes around command structures #2214
Merged
Conversation
This file contains 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
This prevents empty command structure boxes. It only affects three cases, the elements c, e and r (6.1, 6.2 and 6.3). These three elements are described with the pattern 'text' for simplicity.
Conventional Commits Report
🚀 Conventional commits found. |
bjoernricks
approved these changes
Jun 4, 2024
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
Add background boxes to the command structures in the HTML GMP doc.
This affects the Commands and Responses in section 7 (
Command Details) and the Structures in section 6 (Element Details).The color is chosen to match the Greenbone Community Documentation because the HTML will end up as the Greenbone GMP page.
Why
The GMP doc is long and hard to read. The boxes make it easier to see where the XML is broken down.
Example: Element Details
Before
After
Example: Command Details
Before
After
References
Similar to XML boxes in /pull/2192