Appendix D: Contributing to this guide

You can contribute to this guide by following these steps:

  • The guide uses AsciiDoctor to generate the final HTML/PDF so you should consult with its syntax

  • Fork Apache Wicket’s GIT repository to your own github account

  • Clone your forked copy of Apache Wicket’s repository into your machine

  1. git clone https://github.com/<<your github username>>/wicket.git

  • Edit the .adoc files in wicket/wicket-user-guide/src/main/asciidoctor folder

  • To preview your changes run mvn clean package -P guide in the wicket/wicket-user-guide folder (You may use a run configuration in your IDE)

  • Navigate to wicket/wicket-user-guide/target/generated-docs and open one of the following files in a browser / pdf viewer:

    • single.html (single page version)

    • single.pdf (single page pdf version)

  • Create a ticket in Apache Wicket’s JIRA

  • Commit and push the changes to your forked Apache Wicket’s GIT repository and create a pull request on github (Enter the created JIRA ticket id into your pull request’s title)

Thank you!