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