Update markdown documents #386
Conversation
vburckhardt
requested review from
SirSpidey
and removed request for
SirSpidey
|
Hello @SirSpidey - thoughts on this initial version? Not 100% perfect, but perhaps it can be used as a good basis doing 80% of the work. |
vburckhardt
changed the title
|
/run pipeline |
vburckhardt
changed the title
SirSpidey
left a comment
SirSpidey
left a comment
There was a problem hiding this comment.
a bunch of suggestions for this pass. Let me know if they don't make sense.
| You can report issues and request features for this module in GitHub issues in the module repo. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md). | ||
|
|
||
| To set up your local development environment, see [Local development setup](https://terraform-ibm-modules.github.io/documentation/#/local-dev-setup) in the project documentation. | ||
| To set up your local development environment, see [Local Development Setup](https://terraform-ibm-modules.github.io/documentation/#/local-dev-setup) in the project documentation. |
There was a problem hiding this comment.
this is correct as it was, with sentence case (Local development setup).
| @@ -1,20 +1,20 @@ | |||
| # Pre-wired CBR configuration for FS Cloud example | |||
| # Pre-wired CBR Configuration for FS Cloud Example | |||
There was a problem hiding this comment.
Capitalization was correct in the original
| # Tests | ||
|
|
||
| For information about how to create and run tests, see [Validation tests](https://terraform-ibm-modules.github.io/documentation/#/tests) in the project documentation. | ||
| For information about how to create and run tests, see [Validation Tests](https://terraform-ibm-modules.github.io/documentation/#/tests) in the project documentation. |
There was a problem hiding this comment.
capitalization was correct in original
| * [CBR Multi Service Profile](./examples/multi-service-profile) | ||
| * [Multi-Resource Rule Example](./examples/multi-resource-rule) | ||
| * [Multi-zone Example](./examples/multizone-rule) | ||
| * [Pre-wired CBR Configuration for FS Cloud Example](./examples/fscloud) | ||
| * [Zone Example](./examples/zone) |
There was a problem hiding this comment.
these should all go back to the original capitalization after the files are updated and the pre-commit hook runs.
|
@vburckhardt I think I missed the point of this PR. I reviewed the content as I would normally. I didn't realize until now that it was an update from an LLM. I think it could be good to check how well this performs against the Vale tool that we have available for Cloud docs. Does pretty well
Doesn't match IBM style, grammar, and terminology
Doesn't match tech writing practices
|
|
@SirSpidey I was about to mention that the tool seems to be telling us to do capitilazation in places you told us not to :) For example here |
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
|
@vburckhardt, closing this for now. |
LLM-Assisted Editing Enhancement
To make the most of your modifications or further developments, it's advisable to use the specific branch from which this Pull Request (PR) originates. This will ensure you have a solid and up-to-date foundation for your tweaks and enhancements.
Using Markdown LLM Corrector.