You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shiro.apache.org by bd...@apache.org on 2020/08/22 17:40:09 UTC

[shiro-site] branch master updated: .asf.yaml needs to be included in the asf-site branch in order for the files to be published

This is an automated email from the ASF dual-hosted git repository.

bdemers pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shiro-site.git


The following commit(s) were added to refs/heads/master by this push:
     new 10bbbf3  .asf.yaml needs to be included in the asf-site branch in order for the files to be published
10bbbf3 is described below

commit 10bbbf308decaf39d343cad256f1f724f4fd8016
Author: Brian Demers <bd...@apache.org>
AuthorDate: Sat Aug 22 13:39:59 2020 -0400

    .asf.yaml needs to be included in the asf-site branch in order for the files to be published
---
 README.md          | 31 ++++++++++++++++++++-----------
 config.scms.groovy |  2 +-
 2 files changed, 21 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 6d384a8..ce9477a 100644
--- a/README.md
+++ b/README.md
@@ -2,22 +2,31 @@
 
 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.
+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.
 
-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.
+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](https://github.com/lhazlewood/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:
+The following example assumes you have commit permissions to the `apache/shiro-site` repository, 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"
+    # 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 
+
 
diff --git a/config.scms.groovy b/config.scms.groovy
index 081f361..89af018 100644
--- a/config.scms.groovy
+++ b/config.scms.groovy
@@ -1,6 +1,6 @@
 scms {
 
-    excludes = ['templates/**', '**/.svn', '**/.git', '**/.gitignore', '**/*.iml', '**/*.ipr', '**/*.iws', '**/.idea', '.asf.yaml']
+    excludes = ['templates/**', '**/.svn', '**/.git', '**/.gitignore', '**/*.iml', '**/*.ipr', '**/*.iws', '**/.idea']
 
     //global defaults:
     //model {