.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. .asf.yaml
  2. .gitignore
  3. .htaccess
  4. 10-minute-tutorial.md.vtl
  5. 2010/
  6. 2011/
  7. 2012/
  8. 2013/
  9. README.md
  10. about.md
  11. adoption.md
  12. architecture.md.vtl
  13. articles.md
  14. assets/
  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. jaxrs.md.vtl
  66. jsp-tag-library.md
  67. license.md
  68. mailing-lists.md.vtl
  69. navigation.md
  70. news.html
  71. overview.md
  72. performing-a-release.html.vtl
  73. permissions.md
  74. powered-by-shiro.md
  75. privacy-policy.md
  76. quickstart.html.vtl
  77. realm.md.vtl
  78. reference.md
  79. robots.txt
  80. security-reports.md
  81. securitymanager.md.vtl
  82. session-management-features.md
  83. session-management.md.vtl
  84. sessionmanager.html.vtl
  85. shiro-web/
  86. sitemap.xml
  87. spring-boot.md.vtl
  88. spring-framework.md.vtl
  89. spring-xml.md
  90. spring.md
  91. static/
  92. subject.md.vtl
  93. support.md
  94. tags.html
  95. team.md
  96. templates/
  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