Author: jross
Date: Fri Jul 12 12:51:22 2013
New Revision: 1502540
URL: http://svn.apache.org/r1502540
Log:
QPID-4987: Collapse the publish step into the render step; update the README
accordingly
Modified:
qpid/site/Makefile
qpid/site/README
Modified: qpid/site/Makefile
URL:
http://svn.apache.org/viewvc/qpid/site/Makefile?rev=1502540&r1=1502539&r2=1502540&view=diff
==============================================================================
--- qpid/site/Makefile (original)
+++ qpid/site/Makefile Fri Jul 12 12:51:22 2013
@@ -1,4 +1,4 @@
-.PHONY: default help render check-links clean publish-devel publish
+.PHONY: default help render devel-render check-links check-output-files clean
devel-publish
ifndef TRANSOM_HOME
$(error "Run 'source config.sh' first")
@@ -10,40 +10,42 @@ SITE_URL := file://$(shell readlink -f $
default: render
help:
- @echo "render (the default)"
- @echo "check-links"
- @echo "clean"
- @echo "publish"
- @echo "gen-release RELEASE=\$VERSION"
- @echo "gen-proton-release RELEASE=\$VERSION"
+ @echo "[default] Equivalent to 'make render'"
+ @echo "render Renders input/* to output/ and docs/"
+ @echo "clean Removes output/"
+ @echo "check-links [EXTERNAL=0]"
+ @echo " Verify that all links have targets"
+ @echo "gen-release RELEASE=\$VERSION [CURRENT=0]"
+ @echo " Generate release content"
+ @echo "gen-proton-release RELEASE=\$VERSION [CURRENT=0]"
+ @echo " Generate Proton release content"
-render:
+render: devel-render
+ scripts/render http://qpid.apache.org input docs
+
+devel-render:
mkdir -p ${OUTPUT_DIR}
scripts/render ${SITE_URL} input ${OUTPUT_DIR}
-check-output-files: render
+devel-publish: TAG := "head"
+devel-publish: OUTPUT_DIR := $(shell mktemp -d)
+devel-publish: SITE_URL := /~jross/transom/${TAG}
+devel-publish: devel-render
+ chmod 755 ${OUTPUT_DIR}
+ rsync -av ${OUTPUT_DIR}/
jr...@people.apache.org:public_html/transom/${TAG}
+ rm -rf ${OUTPUT_DIR}
+
+check-output-files: devel-render
scripts/check-output-files ${SITE_URL} input ${OUTPUT_DIR}
check-links: INTERNAL := 1
check-links: EXTERNAL := 0
-check-links: render
+check-links: devel-render
scripts/check-links ${SITE_URL} input ${OUTPUT_DIR} ${INTERNAL}
${EXTERNAL}
clean:
rm -rf ${OUTPUT_DIR}
-publish-devel: TAG := "head"
-publish-devel: OUTPUT_DIR := $(shell mktemp -d)
-publish-devel: SITE_URL := /~jross/transom/${TAG}
-publish-devel: render
- chmod 755 ${OUTPUT_DIR}
- rsync -av ${OUTPUT_DIR}/
jr...@people.apache.org:public_html/transom/${TAG}
- rm -rf ${OUTPUT_DIR}
-
-publish: OUTPUT_DIR := docs
-publish: SITE_URL := http://qpid.apache.org
-publish: render
-
gen-release:
gen-release-page
gen-release-notes
Modified: qpid/site/README
URL:
http://svn.apache.org/viewvc/qpid/site/README?rev=1502540&r1=1502539&r2=1502540&view=diff
==============================================================================
--- qpid/site/README (original)
+++ qpid/site/README Fri Jul 12 12:51:22 2013
@@ -5,7 +5,7 @@
To setup paths in your environment, source the `config.sh` script.
~$ cd transom/
- transom$ . config.sh
+ transom$ source config.sh
## Project layout
@@ -14,8 +14,8 @@ To setup paths in your environment, sour
python/ # Python library code; used by scripts
scripts/ # Scripts called by the make rules
input/ # The site content before rendering
- output/ # The rendered result
- docs/ # Used to publish changes to the live site
+ output/ # Rendered result for local testing
+ docs/ # Rendered result for publication to the site
Some notable files in `input/`:
@@ -29,9 +29,8 @@ Some notable files in `input/`:
After that most everything is accomplished by running make targets.
These are the important ones:
- transom$ make render # Renders input/* to output/
+ transom$ make render # Renders input/* to output/ and docs/
transom$ make clean # Removes output/
- transom$ make publish # Makes your changes live on the website
## Adding content
@@ -50,7 +49,8 @@ These are the important ones:
## Render transformations
The render step takes files under `input/` and reproduces them under
-`output/`. The following transformations are applied in the process:
+`output/` and `docs/`. The following transformations are applied in
+the process:
- `.html` files are just copied
- `.html.in` files are wrapped in the site template and copied
@@ -77,6 +77,10 @@ To illustrate:
@current-release@ -> 0.20
@current-proton-release@ -> 0.4
+Under `output/`, `@site-url@` is set to a path in your development
+environment, to allow for local testing. Under `docs/`, `@site-url@`
+is set to <http://qpid.apache.org>, for publication to the live site.
+
You can see more definitions in `input/site.conf`.
## Generating release content
@@ -113,7 +117,9 @@ install all the required dependencies on
Qpid uses svnpubsub to send new content to the Qpid website. Any file
committed under <http://svn.apache.org/repos/asf/qpid/site/docs/> is
-automatically propagated to the live site.
+automatically propagated to the live site. `make render` renders to
+this same `docs/` directory.
-Once you're done making changes, run `make publish`. This will render
-to `docs/` and ask you to commit your changes.
+To publish, run `make render` and use subversion to commit the
+changes. Any additions or other structural changes under the `docs/`
+tree may require subversion adds or removes.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org
For additional commands, e-mail: commits-h...@qpid.apache.org
