You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shiro.apache.org by bm...@apache.org on 2021/09/08 20:12:27 UTC
[shiro-site] 06/06: [JBake][Content] Converted five more pages.
This is an automated email from the ASF dual-hosted git repository.
bmarwell pushed a commit to branch jbake
in repository https://gitbox.apache.org/repos/asf/shiro-site.git
commit b52106d239d6cc0966734fccc819e1a4819ed3b4
Author: Benjamin Marwell <bm...@apache.org>
AuthorDate: Wed Sep 8 22:09:36 2021 +0200
[JBake][Content] Converted five more pages.
- about.md
- codec.html.vtl => codec.adoc
- core.md
- forums.md
- mailing-lists.md.vtl => mailing-lists.adoc
---
codec.html.vtl | 2 --
core.md | 25 ----------------------
about.md => jbake/content/about.md | 14 +++++++------
jbake/content/codec.adoc | 8 ++++++++
jbake/content/core.md | 31 ++++++++++++++++++++++++++++
forums.md => jbake/content/forums.md | 14 +++++++------
jbake/content/mailing-lists.adoc | 40 ++++++++++++++++++++++++++++++++++++
jbake/jbake.properties | 1 +
jbake/templates/lend_a_hand.ftl | 27 ++++++++++++++++++++++++
mailing-lists.md.vtl | 17 ---------------
10 files changed, 123 insertions(+), 56 deletions(-)
diff --git a/codec.html.vtl b/codec.html.vtl
deleted file mode 100644
index 7261b65..0000000
--- a/codec.html.vtl
+++ /dev/null
@@ -1,2 +0,0 @@
-#todoAddDoc())
-<input type="hidden" id="ghEditPage" value="codec.html.vtl"></input>
diff --git a/core.md b/core.md
deleted file mode 100644
index 427a36b..0000000
--- a/core.md
+++ /dev/null
@@ -1,25 +0,0 @@
-<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 commun [...]
-
-* [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 correcting, 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).
-
-<input type="hidden" id="ghEditPage" value="core.md"></input>
diff --git a/about.md b/jbake/content/about.md
similarity index 51%
rename from about.md
rename to jbake/content/about.md
index bdfff43..1581475 100644
--- a/about.md
+++ b/jbake/content/about.md
@@ -1,7 +1,11 @@
-<a name="About-AboutApacheShiro"></a>
-#About Apache Shiro
+title=About Apache Shiro
+type=page
+tags=documentation, about
+status=published
+~~~~~~
-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.
+Apache Shiro is is a top level open source project under the [Apache Software Foundation](https://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
@@ -9,10 +13,8 @@ If you'd like to learn more about Shiro please visit the links below
* [Features](features.html) - Explore the major features of the project
-* [News](news.html) - Stay up to date on the latest Apache Shiro news
+* [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
-
-<input type="hidden" id="ghEditPage" value="about.md"></input>
diff --git a/jbake/content/codec.adoc b/jbake/content/codec.adoc
new file mode 100644
index 0000000..2c37716
--- /dev/null
+++ b/jbake/content/codec.adoc
@@ -0,0 +1,8 @@
+= Apache Shiro Codecs
+:jbake-type: lend_a_hand
+:jbake-status: published
+:jbake-tags: documentation, todo, lend-a-hand
+:idprefix:
+:icons: font
+
+TODO
diff --git a/jbake/content/core.md b/jbake/content/core.md
new file mode 100644
index 0000000..69b0ae8
--- /dev/null
+++ b/jbake/content/core.md
@@ -0,0 +1,31 @@
+title=Core Concepts in Apache Shiro
+type=page
+tags=documentation, about
+status=published
+~~~~~~
+
+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 correcting, 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](https://lists.apache.org/list.html?user@shiro.apache.org) or the [User Mailing List](mailing-lists.html).
+
diff --git a/forums.md b/jbake/content/forums.md
similarity index 56%
rename from forums.md
rename to jbake/content/forums.md
index 54baa49..8649ab0 100644
--- a/forums.md
+++ b/jbake/content/forums.md
@@ -1,15 +1,17 @@
-<a name="Forums-ApacheShiroCommunityForums"></a>
-#Apache Shiro Community Forums
+title=Apache Shiro Community Forums
+type=page
+tags=documentation, community
+status=published
+~~~~~~
For users that prefer to use browse the mailing lists with a browser can use [ASF Lists](https://lists.apache.org/) (Pony Mail).
-* [Shiro User Forum](https://lists.apache.org/list.html?user@shiro.apache.org)
-* [Shiro Developer Forum](https://lists.apache.org/list.html?dev@shiro.apache.org)
+* [Shiro User Forum](https://lists.apache.org/list.html?user@shiro.apache.org)
+* [Shiro Developer Forum](https://lists.apache.org/list.html?dev@shiro.apache.org)
> **NOTE:** Previously, `nabble.com` was used as an alternative to the mailing list, this service is not longer hosting the mailing list archive.
<a name="Forums-MailingLists"></a>
-##Mailing Lists
+## Mailing Lists
For those that may prefer mailing lists, please see the [Mailing Lists](mailing-lists.html) information.
-<input type="hidden" id="ghEditPage" value="forums.md"></input>
diff --git a/jbake/content/mailing-lists.adoc b/jbake/content/mailing-lists.adoc
new file mode 100644
index 0000000..24ea079
--- /dev/null
+++ b/jbake/content/mailing-lists.adoc
@@ -0,0 +1,40 @@
+= Apache Shiro Mailing Lists
+:jbake-type: page
+:jbake-status: published
+:jbake-tags: documentation, mailing, contact
+:idprefix:
+:icons: font
+
+
+|===
+|List Name |List Address |Subscribe |Unsubscribe |ASF (Online Forums)
+
+|Shiro User List
+|mailto:user@shiro.apache.org[user@shiro.apache.org]
+|mailto:user-subscribe@shiro.apache.org[Subscribe]
+|mailto:user-unsubscribe@shiro.apache.org[Unsubscribe]
+|link:++https://lists.apache.org/list.html?user@shiro.apache.org++[ASF Forum and Archive]
+
+|Shiro Developer List
+|mailto:dev@shiro.apache.org[dev@shiro.apache.org]
+|mailto:dev-subscribe@shiro.apache.org[Subscribe]
+|mailto:dev-unsubscribe@shiro.apache.org[Unsubscribe]
+|link:++https://lists.apache.org/list.html?dev@shiro.apache.org++[ASF Forum and Archive]
+
+|Shiro Issues/JIRA List
+|mailto:issues@shiro.apache.org[issues@shiro.apache.org]
+|mailto:issues-subscribe@shiro.apache.org[Subscribe]
+|mailto:issues-unsubscribe@shiro.apache.org[Unsubscribe]
+|link:++https://lists.apache.org/list.html?issues@shiro.apache.org++[ASF Forum and Archive]
+
+|Shiro SCM List
+|mailto:commits@shiro.apache.org[commits@shiro.apache.org]
+|mailto:commits-subscribe@shiro.apache.org[Subscribe]
+|mailto:commits-unsubscribe@shiro.apache.org[Unsubscribe]
+|link:++https://lists.apache.org/list.html?commits@shiro.apache.org++[ASF Forum and Archive]
+|===
+
+
+== Discussion Forums
+
+If you prefer you could use our discussion link:forums.html[Forums] which are synced with the above mailing lists.
diff --git a/jbake/jbake.properties b/jbake/jbake.properties
index 7992cc1..3ab2072 100644
--- a/jbake/jbake.properties
+++ b/jbake/jbake.properties
@@ -7,3 +7,4 @@ render.sitemap=true
render.archive=true
template.download.file=download.ftl
+template.lend_a_hand.file=lend_a_hand.ftl
diff --git a/jbake/templates/lend_a_hand.ftl b/jbake/templates/lend_a_hand.ftl
new file mode 100644
index 0000000..885e680
--- /dev/null
+++ b/jbake/templates/lend_a_hand.ftl
@@ -0,0 +1,27 @@
+<#include "header.ftl">
+
+<#include "menu.ftl">
+
+<#if (content.title)??>
+ <div class="page-header">
+ <h1>${content.title}</h1>
+ </div>
+<#else></#if>
+
+<p><em>${content.date?string("dd MMMM yyyy")}</em></p>
+
+<p>TODO</p>
+
+<h2><a id="Lendahandwithdocumentation"></a>Lend a hand with documentation</h2>
+
+<p>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 correcting, expanding, or adding documentation where you see a need.
+ Every little bit of help you provide expands the community and in turn improves Shiro. </p>
+
+<p>The easiest way to contribute your documentation is to submit a pull-request by clicking on the <code>Edit</code> link below,
+ or send it to the <a href="mailing-lists.html" title="Mailing Lists">User Mailing List</a>.</p>
+
+<hr />
+
+<#include "footer.ftl">
diff --git a/mailing-lists.md.vtl b/mailing-lists.md.vtl
deleted file mode 100644
index fd34f7d..0000000
--- a/mailing-lists.md.vtl
+++ /dev/null
@@ -1,17 +0,0 @@
-#mdStyle()
-
-<a name="MailingLists-ApacheShiroMailingLists"></a>
-# Apache Shiro Mailing Lists
-
-| List Name | List Address | Subscribe | Unsubscribe | ASF (Online Forums) |
-|----------------------|-------------------------------------------------------------|--------------------------------------------------------|------------------------------------------------------------|--------------------------------------------------------------------------------------|
-| Shiro User List | [user@shiro.apache.org](mailto:user@shiro.apache.org) | [Subscribe](mailto:user-subscribe@shiro.apache.org) | [Unsubscribe](mailto:user-unsubscribe@shiro.apache.org) | [ASF Forum and Archive](https://lists.apache.org/list.html?user@shiro.apache.org) |
-| Shiro Developer List | [dev@shiro.apache.org](mailto:dev@shiro.apache.org) | [Subscribe](mailto:dev-subscribe@shiro.apache.org) | [Unsubscribe](mailto:dev-unsubscribe@shiro.apache.org) | [ASF Forum and Archive](https://lists.apache.org/list.html?dev@shiro.apache.org) |
-| Shiro Issues/JIRA List | [issues@shiro.apache.org](mailto:issues@shiro.apache.org) | [Subscribe](mailto:issues-subscribe@shiro.apache.org) | [Unsubscribe](mailto:issues-unsubscribe@shiro.apache.org) | [ASF Forum and Archive](https://lists.apache.org/list.html?issues@shiro.apache.org) |
-| Shiro SCM List | [commits@shiro.apache.org](mailto:commits@shiro.apache.org) | [Subscribe](mailto:commits-subscribe@shiro.apache.org) | [Unsubscribe](mailto:commits-unsubscribe@shiro.apache.org) | [ASF Forum and Archive](https://lists.apache.org/list.html?commits@shiro.apache.org) |
-
-<a name="MailingLists-DiscussionForums"></a>
-### Discussion Forums
-
-If you prefer you could use our discussion [Forums](forums.html "Forums") which are sync'd with the above mailing lists.
-<input type="hidden" id="ghEditPage" value="mailing-lists.md"></input>