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

To publish the site commit changes to the asf-site branch of this repository. 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 commit permissions to the apache/shiro-site repository, typically because your are an Apache Shiro project committer:

# clone both repo branches `asf-site` and `master`
git clone https://github.com/apache/shiro-site -b asf-site shiro-site-publish
git clone https://github.com/apache/shiro-site

# build the site
cd shiro-site
scms . ../shiro-site-publish
# Open up the local ../shiro-site-publish/index.html file in your web browser.  Ensure the changes reflect what you want. 

# These next commands will publish changes to live ASF web servers.  Be confident the changes are what you want:
cd ../shiro-site-publish
git add .
git commit -am "my change description"
git push origin asf-site

# It should only take a few minutes until the files are live