esapi-java-legacy icon indicating copy to clipboard operation
esapi-java-legacy copied to clipboard

Update and expand ESAPI-Java-Legacy's GitHub wiki

Open kwwall opened this issue 6 years ago • 0 comments

This is just a general ticket...more of a "master ticket" of sorts (in the JIRA sense at least), so I am not expecting this particular ticket be closed. Rather, if someone wants to work on this, we will expect that a more specific GitHub issue be created and that it refer back to this ticket.

This is a general call for volunteers to help build out the GitHub wiki. It admittedly is rather abysmal at this point.

Note only are many of the current wiki pages outdated, but we have essentially no user documentation. So what can you do to help?

A couple of things come to mind:

  1. Update the existing wiki pages to make sure they are correct and still relevant.
  2. Convert some of the documentation under the 'documentation' directory to GitHub wiki pages.
  3. Write some new tutorials how to use ESAPI.
  4. Scour sites like Stack Overflow and similar sites and from it construct a FAQ for ESAPI.

A good place to look at to get started editing GitHub wiki pages is the "GitHub Wiki How-To" page. Our wiki pages are all built using Markdown.

Some additional useful references:

kwwall avatar Feb 24 '19 20:02 kwwall