#Apache Shiro Developer Reference Information
This page and its children are dedicated for reference information used by the Apache Shiro development team when performing tasks as a committer.
All non-JavaDoc documentation is written in our Apache Shiro Confluence Wiki Space. This space is converted into the public website as described below.
Version 2 has no timeline yet, but if you're interested in seeing what the major ideas are, as well as to contribute any of your own, you can visit the Version 2 Brainstorming Page.
NOTE: This section is out of date. The site is basically just markdown, and you can edit / pull request via Github via the links at the bottom of the page.
The Shiro website is automatically generated based on the content maintained in the Apache Shiro Confluence Wiki Space, with a few notable exceptions that we‘ll cover in a bit. Here’s how it works:
Shiro committers and approved contributors modify the Confluence wiki pages as necessary. The left navigation panel is controlled by the Navigation wiki page.
Confluence detects changes to these pages and executes a 3rd-party Auto Export Confluence Plugin that renders the content to .html files that can be served to the world (this plugin was installed in Confluence by the Apache Infrastructure team). If you're setting up
Auto Export for the first time, read the “Setting up Confluence Export” section below.
The template designer sends the one HTML template file only (and not the referenced static assets) to an Apache member with Confluence administrative privileges and asks them to install their HTML template file into the
Auto Export plugin configuration. Unfortunately only a Confluence administrators may perform this function - the plugin does not support administration on a per-project level.
You will have to separately upload the any referenced static assets to another location. We'll cover that shortly.
.htmlfile (html template + wiki content body = finished page).
The website files are maintained on
> ssh people.apache.org (a bunch of login messages) [lhazlewood@minotaur:~]$ [lhazlewood@minotaur:~]$ cd /www/shiro.apache.org [lhazlewood@minotaur:/www/shiro.apache.org]$
Changes made to any files under this directory are synced and published to a set of mirrored Apache web servers that we can't access. So note: Any changes to files under this directory will be propagated to the public Shiro site. Be careful!