Skip to content

Plugins configuration docs - format parameters as a table#340

Merged
PhillypHenning merged 10 commits intomainfrom
280-plugins-configuration-docs-format-parameters-as-a-table
Nov 3, 2022
Merged

Plugins configuration docs - format parameters as a table#340
PhillypHenning merged 10 commits intomainfrom
280-plugins-configuration-docs-format-parameters-as-a-table

Conversation

@ccapell
Copy link
Copy Markdown
Contributor

@ccapell ccapell commented Oct 27, 2022

Description

Documentation has been formatted to be a table instead of a list

Fixes #280

Type of change

Please delete options that are not relevant.

  • Documentation update

@ccapell ccapell linked an issue Oct 27, 2022 that may be closed by this pull request
2 tasks
@arm4b arm4b added this to the v2.2.0 milestone Oct 31, 2022
@arm4b arm4b added the documentation 📗 Improvements or additions to documentation label Oct 31, 2022
Copy link
Copy Markdown
Contributor

@arm4b arm4b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the changes!
I like the diff here: +108 −549, - fewer lines and so much improved visual clarity by formatting it as a table 👍

I left several comments to address and clarify before we merge it.

@arm4b arm4b added the enhancement ✨ New feature or request label Oct 31, 2022
@arm4b arm4b changed the title 280 plugins configuration docs format parameters as a table Plugins configuration docs - format parameters as a table Oct 31, 2022
Copy link
Copy Markdown
Contributor Author

@ccapell ccapell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes made

@ccapell ccapell requested a review from arm4b November 1, 2022 17:47
@PhillypHenning
Copy link
Copy Markdown
Contributor

Tables look great @ccapell

Screen Shot 2022-11-02 at 3 06 15 PM

Copy link
Copy Markdown
Contributor

@PhillypHenning PhillypHenning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ccapell could you please table-ize the additional information sections for all the plugins 👍

@PhillypHenning
Copy link
Copy Markdown
Contributor

Pigging back on this PR to apply the following doc update

@PhillypHenning PhillypHenning merged commit ef3a84c into main Nov 3, 2022
@PhillypHenning PhillypHenning deleted the 280-plugins-configuration-docs-format-parameters-as-a-table branch November 3, 2022 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📗 Improvements or additions to documentation enhancement ✨ New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Plugins configuration docs: format parameters as a table

5 participants