Converted a few pages about, codec, and core

tzvatot · Oct 21, 2016 · 6ce2b16 · 6ce2b16
1 parent 4e7feb4
commit 6ce2b16
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 94 deletions.
diff --git a/about.html.vtl b/about.html.vtl
diff --git a/about.md b/about.md
@@ -0,0 +1,16 @@
+<a name="About-AboutApacheShiro"></a>
+#About Apache Shiro
+
+Apache Shiro is is a top level open source project under the [Apache Software Foundation](http://www.apache.org). As a project, Shiro is an application security framework that provides application developers very clean and simple ways of supporting four cornerstones of security in their applications: authentication, authorization, enterprise session management and cryptography.
+
+If you'd like to learn more about Shiro please visit the links below
+
+* [What is Shiro](what-is-shiro.html) - A deeper look into the project, its mission, and its history
+
+* [Features](features.html) - Explore the major features of the project
+
+* [News](news.html) - Stay up to date on the latest Apache Shiro news
+
+* [Events](events.html) - See what Apache Shiro events are coming that you should consider attending
+
+* [License](license.html) - Review the license under which Shiro is released - Apache Software License, Version 2.0
diff --git a/codec.html b/codec.html
diff --git a/codec.html.vtl b/codec.html.vtl
@@ -0,0 +1 @@
+#todoAddDoc())
diff --git a/contribute.html b/contribute.html
diff --git a/contribute.md b/contribute.md
@@ -0,0 +1,16 @@
+<a name="Contribute-ContributingtoApacheShiro"></a>
+#Contributing to Apache Shiro
+
+Apache Shiro is a non-profit project and relies on your help and contributions in order to evolve and improve.
+
+At the Shiro project we make it easy for anyone to join our great community and lend a hand.  We welcome any help you can offer inlcuding help with documentation, identifying bugs, providing answers on the user mailing list, and providing helpful code improvements.
+
+Below are helpful links on how you can contribute to the Apache Shiro project.
+
+* [How to Contribute](how-to-contribute.html) - A starting point for contributing to the Shiro project
+
+* [Shiro Issue Tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20SHIRO%20AND%20status%20%3D%20Open%20ORDER%20BY%20priority%20DESC) - Once you're ready to contribute, this is a good place to see what needs to get done
+
+* [Donate to ASF](http://www.apache.org/foundation/sponsorship.html) - Shiro is a project under the Apache Software Foundation, a non-profit that relies on donations and community support
+
+* [Developer Resources](developer-resources.html) - Helpful information for anyone providing project help as a committer or contributor
diff --git a/core.html b/core.html
diff --git a/core.md b/core.md
@@ -0,0 +1,23 @@
+<a name="Core-CoreConceptsinApacheShiro"></a>
+#Core Concepts in Apache Shiro
+
+This part of the documentation covers Shiro's core architectural concepts.
+
+First we'll present Shiro's architecture and a summary of each core concept.  Then we'll cover the most important concept in Shiro - the `Subject`, a security-specific 'view' of a <em>single</em> application user.  Next we'll discuss the <tt>SecurityManager</tt>, an application singleton that manages all Subjects for the application, and as well as the SecurityManager's supporting components that do most of Shiro's heavy lifting. Then onto Realms, the security-specific DAOs, Shiro communicates with and then Permissions, the building block of any security policy.
+
+* [Architecture](architecture.html)
+
+* [Subject](subject.html)
+
+* [SecurityManager](securitymanager.html)
+
+* [Realms](realm.html)
+
+* [Permissions](permissions.html)
+
+<a name="Core-Lendahandwithdocumentation"></a>
+##Lend a hand with documentation
+
+While we hope this documentation helps you with the work you're doing with Apache Shiro, the community is improving and expanding the documentation all the time.  If you'd like to help the Shiro project, please consider corrected, expanding, or adding documentation where you see a need. Every little bit of help you provide expands the community and in turn improves Shiro.
+
+The easiest way to contribute your documentation is to send it to the [User Forum](http://shiro-user.582556.n2.nabble.com/) or the [User Mailing List](mailing-lists.html).