Adding site.xml and minor cleanup detected by google analytics
4 files changed
tree: 529e2f5a7e631a9f500403b7cce719540ccd1820
  1. 2010/
  2. 2011/
  3. 2012/
  4. 2013/
  5. assets/
  6. shiro-web/
  7. templates/
  8. .gitignore
  9. .htaccess
  10. 10-minute-tutorial.md.vtl
  11. about.md
  12. adoption.md
  13. architecture.md.vtl
  14. articles.md
  15. authentication-features.md
  16. authentication-guide.html.vtl
  17. authentication.md.vtl
  18. authenticator.html.vtl
  19. authorization-features.md
  20. authorization.md.vtl
  21. authorizer.html.vtl
  22. banner.html.vtl
  23. cachemanager.md
  24. caching.md
  25. cas.md.vtl
  26. codec.html.vtl
  27. command-line-hasher.md
  28. commercial-support.md
  29. community.md
  30. concurrency.md
  31. conferences.md
  32. config.scms.groovy
  33. configuration.md.vtl
  34. confluence-auto-export.html.vtl
  35. contribute.md
  36. core.md
  37. cryptography-features.md
  38. cryptography.md
  39. deprecated-pages.html
  40. developer-resources.md.vtl
  41. developers.md
  42. documentation-help-block.md
  43. documentation.md.vtl
  44. download.html.vtl
  45. events.md
  46. features-overview.md
  47. features.md
  48. forums.md
  49. get-started.md
  50. getting-started-block.md
  51. graduation-resolution.md
  52. guice.md.vtl
  53. guides.md
  54. how-to-contribute.md
  55. inclusionslibrary.md
  56. index.html
  57. integration.md
  58. introduction.md
  59. issues.md
  60. java-annotations-list.md
  61. java-annotations.md
  62. java-authentication-guide.md.vtl
  63. java-authorization-guide.md.vtl
  64. java-cryptography-guide.md.vtl
  65. jsp-tag-library.md
  66. license.md
  67. mailing-lists.md.vtl
  68. navigation.md
  69. news.html
  70. overview.md
  71. performing-a-release.html.vtl
  72. permissions.md
  73. powered-by-shiro.md
  74. privacy-policy.md
  75. quickstart.html.vtl
  76. README.md
  77. realm.md.vtl
  78. reference.md
  79. securitymanager.md.vtl
  80. session-management-features.md
  81. session-management.md.vtl
  82. sessionmanager.html.vtl
  83. site.xml
  84. spring.md
  85. subject.md.vtl
  86. support.md
  87. tags.html
  88. team.md
  89. terminology.md
  90. testing.md.vtl
  91. tools.md
  92. tutorial.md.vtl
  93. version-2-brainstorming.md
  94. web-features.md
  95. web.md.vtl
  96. webapp-tutorial.md
  97. what-is-shiro.md
  98. wiki-todos.md
README.md

Apache Shiro Website Overview

The Apache Shiro website is a static content website accessible at http://shiro.apache.org

Site content is authored as Markdown and HTML files. These files are scanned by a tool that applies a page template to each file's contents as necessary, and the rendered static .html files are output to a publish directory.

Publishing site changes is as simple as committing any changes in the publish directory to version control. ASF infrastructure will see the commit and automatically push the changes to the ASF's production webservers.

Generating and Publishing

The tool used to generate the static content is SCMS. Once scms is installed and in your $PATH, generating and publishing the site on the command line is easy.

The following example assumes you have SVN commit permissions to the publish directory, typically because your are an Apache Shiro project committer:

cd site
# This next command will take a few seconds, be patient :)
scms trunk publish
# Open up the local publish/index.html file in your web browser.  Ensure the changes reflect what you want. 
#
# This next commands will publish changes to live ASF web servers.  Be confident the changes are what you want:
svn add .
svn commit -m "my change description"