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
- Create a sub-issue for the adoc page you are going to work on
- Submit a pull request to the 6.5.x branch with the changes using https://github.com/spring-projects/spring-security/commit/6eee256e12663a5465be6fceffe0b75178f23c37 as a guide to how to make the changes
- However, please make the changes to the entire adoc page in a single commit / PR.
- Consider adding tests if it makes sense
Comment From: christophsj
Hi! I am a spring security user and I would love to contribute.
However, I do not seem to be able to create a sub issue. I am a first time contributor, is this expected?
Comment From: jkuhel
Hi @rwinch
I would like to help on this issue if it is still available to work on.
To get started, I did attempt to create a sub-issue to work on docs/modules/ROOT/pages/servlet/test/method.adoc. However, I was not able to because it looks like only accounts with at least triage permissions for a given repository can create sub-issues. I'd be glad to create sub-issues if my account has permissions. Let me know what's best.
In the mean time, I followed your example and made changes to the above page to use include-code and added some tests. For the time being, I opened this PR to the 6.5.x branch to start with. Please let me know if this helpful and on the right track.
If everything looks good here as a starting point, I can recreate the branch and PR once a sub-issue is created and link the commit/PR accordingly.
I can also take on the updates to additional pages and happy to collaborate/divide up the pages with others (like @christophsj).