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