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/25 11:56:40 UTC
[shiro-site] branch jbake updated: move 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
The following commit(s) were added to refs/heads/jbake by this push:
new 71ac693 move more pages.
new 5dd35cf Merge pull request #95 from bmarwell/jbake
71ac693 is described below
commit 71ac6938d1aea2bc1e7d3114f7a91a52af6c4043
Author: Benjamin Marwell <bm...@apache.org>
AuthorDate: Sat Sep 25 13:56:27 2021 +0200
move more pages.
---
cachemanager.md | 43 --------------------------
deprecated-pages.html | 2 --
developers.md | 53 --------------------------------
adoption.md => jbake/content/adoption.md | 8 +++--
jbake/content/cachemanager.adoc | 41 ++++++++++++++++++++++++
jbake/content/developers.adoc | 20 ++++++++++++
jbake/content/tools.md | 7 +++++
tools.md | 2 --
8 files changed, 73 insertions(+), 103 deletions(-)
diff --git a/cachemanager.md b/cachemanager.md
deleted file mode 100644
index 0947eb9..0000000
--- a/cachemanager.md
+++ /dev/null
@@ -1,43 +0,0 @@
-# Cache Manager
-
-Shiro has three important cache interfaces:
-
-* [`CacheManager`](static/current/apidocs/org/apache/shiro/cache/CacheManager.html)
-
-* [`Cache`] (static/current/apidocs/org/apache/shiro/cache/Cache.html)
-
-* [`CacheManagerAware`] (static/current/apidocs/org/apache/shiro/cache/CacheManagerAware.html)
-
-A `CacheManager` returns `Cache` instances and various Shiro components use those `Cache<` instances to cache data as necessary. Any Shiro<br clear="none">
-component that implements `CacheManager` will automatically receive a configured `CacheManager`, where it can be used to acquire `Cache` instances.
-
-The Shiro [`SecurityManager`](securitymanager.html) implementations and all [`AuthorizingRealm`](static/current/apidocs/org/apache/shiro/realm/AuthorizingRealm.html) implementations implement CacheManagerAware. If you set the `CacheManager` on the `SecurityManager`, it will in turn set it on the various Realms that implement CacheManagerAware as well (OO delegation). For example, in shiro.ini:
-
-**example shiro.ini CacheManager configuration**
-
-``` ini
-
-securityManager.realms = $myRealm1, $myRealm2, ..., $myRealmN
-...
-cacheManager = my.implementation.of.CacheManager
-...
-securityManager.cacheManager = $cacheManager
-# at this point, the securityManager and all CacheManagerAware
-# realms have been set with the cacheManager instance
-```
-
-We have an out-of-the-box [`EhCacheManager`](static/current/apidocs/org/apache/shiro/cache/ehcache/EhCacheManager.html) implementation, so you can use that today if you wanted. Otherwise, you can implement your own `CacheManager` (e.g. with Coherence, etc) and configure it as above, and you'll be good to go.
-
-<a name="CacheManager-AuthorizationCacheInvalidation"></a>
-###Authorization Cache Invalidation
-
-Finally note that [`AuthorizingRealm`](static/current/apidocs/org/apache/shiro/realm/AuthorizingRealm.html) has a [`clearCachedAuthorizationInfo`](static/current/apidocs/org/apache/shiro/realm/AuthorizingRealm.html#clearCachedAuthorizationInfo%28org.apache.shiro.subject.PrincipalCollection%29) method that can be called by subclasses to evict the cached authzInfo for a particular account. It is usually called by custom logic if the corresponding account's authz data has changed (to ensur [...]
-
-<a name="CacheManager-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 <a class="external-link" href="http://shiro-user.582556.n2.nabble.com/" rel="nofollow">User Forum</a> or the <a href="mailing-lists.html" title="Mailing Lists">User Mailing List</a>.
-
-<input type="hidden" id="ghEditPage" value="cachemanager.md"></input>
diff --git a/deprecated-pages.html b/deprecated-pages.html
deleted file mode 100644
index 4131680..0000000
--- a/deprecated-pages.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-<input type="hidden" id="ghEditPage" value="deprecated-pages.html"></input>
diff --git a/developers.md b/developers.md
deleted file mode 100644
index 1b6117c..0000000
--- a/developers.md
+++ /dev/null
@@ -1,53 +0,0 @@
-<a name="Developers-ApacheShiroDeveloperReferenceInformation"></a>
-#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.
-
-<a name="Developers-WritingDocumentation"></a>
-##Writing Documentation
-
-All non-JavaDoc documentation is written in our [Apache Shiro Confluence Wiki Space](https://cwiki.apache.org/confluence/display/SHIRO). This space is converted into the public website as described below.
-
-<a name="Developers-Version2Brainstorming"></a>
-##Version 2 Brainstorming
-
-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](https://cwiki.apache.org/confluence/display/SHIRO/Version+2+Brainstorming).
-
-<a name="Developers-Website"></a>
-##Website
-
-**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.
-
-More on this soon!
-
-The Shiro website is automatically generated based on the content maintained in the [Apache Shiro Confluence Wiki Space](https://cwiki.apache.org/confluence/display/SHIRO), with a few notable exceptions that we'll cover in a bit. Here's how it works:
-
-1. Shiro committers and approved contributors modify the Confluence wiki pages as necessary. The left navigation panel is controlled by the [Navigation wiki page](https://cwiki.apache.org/confluence/display/SHIRO/Navigation).
-
-2. Confluence detects changes to these pages and executes a 3rd-party [Auto Export Confluence Plugin](http://code.google.com/p/couldit-autoexport) 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.
-
- 1. A project contributor makes a single Velocity-based HTML template file. It can reference associated static assets (images, css files, javascript, etc) as necessary. They test it in their HTML design tool of choice to get the look and feel they want.
-
- 2. 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.
-
- 3. The Confluence administrator installs the HTML template for the project's space only.
- 4. For each wiki page, the auto export plugin merges the page content with an HTML template and outputs a new `.html` file (html template + wiki content body = finished page).
- 5. All of the output files and any associated data (attachments, etc) are placed in a filesystem directory that mirrors content tree hierarchy in the wiki.
- the The output files mirror the fileThe auto export plugin takes all of the pages and their content (attachments, etc), applies a single HTML template to each wiki page, and outputs each 'merged' page (html template + embedded wiki content = finished page)
-
-The website files are maintained on `people.apache.org` in `/www/shiro.apache.org`:
-
-``` bash
-> 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!
-<input type="hidden" id="ghEditPage" value="developers.md"></input>
diff --git a/adoption.md b/jbake/content/adoption.md
similarity index 65%
rename from adoption.md
rename to jbake/content/adoption.md
index ac1668d..4ce46e9 100644
--- a/adoption.md
+++ b/jbake/content/adoption.md
@@ -1,7 +1,9 @@
-<a name="Adoption-ApacheShiroAdoption"></a>
-#Apache Shiro Adoption
+title=Apache Shiro Adoption
+type=page
+tags=documentation, about
+status=published
+~~~~~~
Are you using Shiro to build an application? List your name and company here and let the world know!
The more people that adopt Shiro, the better it becomes, and the more you benefit from it. Help adoption by letting others know how you use it.
-<input type="hidden" id="ghEditPage" value="adoption.md"></input>
diff --git a/jbake/content/cachemanager.adoc b/jbake/content/cachemanager.adoc
new file mode 100644
index 0000000..9df04c0
--- /dev/null
+++ b/jbake/content/cachemanager.adoc
@@ -0,0 +1,41 @@
+= Cache Manager
+:jbake-type: page
+:jbake-status: published
+:jbake-tags: documentation, cache
+:idprefix:
+
+== Apache Shiro Cache Manager Overview
+
+Shiro has three important cache interfaces:
+
+* link:static/current/apidocs/org/apache/shiro/cache/CacheManager.html[`+CacheManager+`]
+* link:static/current/apidocs/org/apache/shiro/cache/Cache.html[`+Cache+`]
+* link:static/current/apidocs/org/apache/shiro/cache/CacheManagerAware.html[`+CacheManagerAware+`]
+
+A `+CacheManager+` returns `+Cache+` instances and various Shiro components use those `+Cache<+` instances to cache data as necessary.
+Any Shiro component that implements `+CacheManager+` will automatically receive a configured `+CacheManager+`, where it can be used to acquire `+Cache+` instances.
+
+The Shiro link:securitymanager.html[`+SecurityManager+`] implementations and all
+link:static/current/apidocs/org/apache/shiro/realm/AuthorizingRealm.html[`+AuthorizingRealm+`] implementations implement CacheManagerAware.
+If you set the `+CacheManager+` on the `+SecurityManager+`, it will in turn set it on the various Realms that implement CacheManagerAware as well (OO delegation).
+For example, in shiro.ini:
+
+[source,ini]
+.example shiro.ini CacheManager configuration
+----
+securityManager.realms = $myRealm1, $myRealm2, ..., $myRealmN
+...
+cacheManager = my.implementation.of.CacheManager
+...
+securityManager.cacheManager = $cacheManager
+# at this point, the securityManager and all CacheManagerAware
+# realms have been set with the cacheManager instance
+----
+
+We have an out-of-the-box link:static/current/apidocs/org/apache/shiro/cache/ehcache/EhCacheManager.html[`+EhCacheManager+`] implementation, so you can use that today if you wanted.
+Otherwise, you can implement your own `+CacheManager+` (e.g. with Coherence, etc) and configure it as above, and you’ll be good to go.
+
+== Authorization Cache Invalidation [[CacheManager-AuthorizationCacheInvalidation]]
+
+Finally note that link:static/current/apidocs/org/apache/shiro/realm/AuthorizingRealm.html[`+AuthorizingRealm+`] has a link:static/current/apidocs/org/apache/shiro/realm/AuthorizingRealm.html#clearCachedAuthorizationInfo%28org.apache.shiro.subject.PrincipalCollection%29[`+clearCachedAuthorizationInfo+`] method that can be called by subclasses to evict the cached authzInfo for a particular account.
+It is usually called by custom logic if the corresponding account’s authz data has changed (to ensure the next authz check will pick up the new data).
diff --git a/jbake/content/developers.adoc b/jbake/content/developers.adoc
new file mode 100644
index 0000000..c10eb3a
--- /dev/null
+++ b/jbake/content/developers.adoc
@@ -0,0 +1,20 @@
+= Apache Shiro Developer Reference Information [[Developers-ApacheShiroDeveloperReferenceInformation]]
+:jbake-type: page
+:jbake-status: published
+:jbake-tags: documentation, developer
+:idprefix:
+
+This page and its children are dedicated for reference information used by the Apache Shiro development team when performing tasks as a committer.
+
+== Writing Documentation [[Developers-WritingDocumentation]]
+
+All non-JavaDoc documentation is written as asciidoc on git.
+See link:https://github.com/apache/shiro-site[this site on GitHub].
+
+== Version 2 Brainstorming [[Developers-Version2Brainstorming]]
+
+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 https://cwiki.apache.org/confluence/display/SHIRO/Version+2+Brainstorming[Version 2 Brainstorming Page].
+
+== Website [[Developers-Website]]
+
+See link:https://github.com/apache/shiro-site/blob/jbake/jbake/CONTRIBUTING.adoc[CONTRIBUTING.adoc]
diff --git a/jbake/content/tools.md b/jbake/content/tools.md
new file mode 100644
index 0000000..0aea6d5
--- /dev/null
+++ b/jbake/content/tools.md
@@ -0,0 +1,7 @@
+title=Apache Shiro Tools
+type=page
+tags=documentation, tools
+status=published
+~~~~~~
+
+[Command Line Hasher](command-line-hasher.html)
diff --git a/tools.md b/tools.md
deleted file mode 100644
index 3721b34..0000000
--- a/tools.md
+++ /dev/null
@@ -1,2 +0,0 @@
-[Command Line Hasher](command-line-hasher.html)
-<input type="hidden" id="ghEditPage" value="tools.md"></input>