We should use include-code for all samples within the documentation. This will allow us to test the sample code to ensure that it works.
If you are wanting to contribute to this issue, please:
- Select a single adoc page that you will work on
- Check to see that it isn't already being worked on
- Comment on this ticket that you will be working on it
- Submit a pull request to the main branch with the changes using 6eee256 as a guide to how to make the changes
- However, please make the changes to the entire adoc page in a single commit / PR.
- Before submitting the pull request, please diff the html page that is generated by
./gradlew antora before and after your changes
- Please also search the updated HTML output for
:: as this can find any macros that were not ran .
- Consider adding tests if it makes sense
PRs
We should use include-code for all samples within the documentation. This will allow us to test the sample code to ensure that it works.
If you are wanting to contribute to this issue, please:
./gradlew antorabefore and after your changes::as this can find any macros that were not ran .PRs