You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jr...@apache.org on 2016/01/29 01:48:59 UTC
svn commit: r1727462 - in /qpid/site: Makefile README
Author: jross
Date: Fri Jan 29 00:48:58 2016
New Revision: 1727462
URL: http://svn.apache.org/viewvc?rev=1727462&view=rev
Log:
QPID-6970: Avoid double rendering every time: add a dedicated publish step with svn instructions; move the phony directives closer to the rule defs
Modified:
qpid/site/Makefile
qpid/site/README
Modified: qpid/site/Makefile
URL: http://svn.apache.org/viewvc/qpid/site/Makefile?rev=1727462&r1=1727461&r2=1727462&view=diff
==============================================================================
--- qpid/site/Makefile (original)
+++ qpid/site/Makefile Fri Jan 29 00:48:58 2016
@@ -1,9 +1,26 @@
-.PHONY: default help render devel-render check-links check-output-files clean devel-publish
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
export PYTHONPATH = python
OUTPUT_DIR := output
-SITE_URL := file://$(shell readlink -f ${OUTPUT_DIR})
+SITE_URL := file://$(abspath ${OUTPUT_DIR})
ifdef RELEASE
ifndef ISSUES_RELEASE
@@ -15,8 +32,10 @@ ifdef RELEASE
endif
endif
+.PHONY: default
default: render
+.PHONY: help
help:
@echo "[default] Equivalent to 'make render'"
@echo "render Renders input/* to output/ and docs/"
@@ -34,44 +53,65 @@ help:
@echo "gen-cpp-release RELEASE=\$$VERSION [CHECKOUT_DIR=\$$DIR]"
@echo " Generate Qpid C++ release content"
-render: devel-render
- scripts/render "" input docs
+.PHONY: render
+render:
+ scripts/render ${SITE_URL} input ${OUTPUT_DIR}
@echo "See the output in your browser at ${SITE_URL}/index.html"
-devel-render:
- scripts/render ${SITE_URL} input ${OUTPUT_DIR}
+.PHONY: publish
+publish:
+ scripts/render "" input docs
+ svn status docs
+ @echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+ @echo "NOTICE! One more step remains!"
+ @echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+ @echo "Use svn to commit the changes under docs. Keep in mind that you"
+ @echo "may need to svn add new files."
+.PHONY: devel-publish
devel-publish: TAG := "head"
devel-publish: OUTPUT_DIR := $(shell mktemp -d --dry-run)
devel-publish: SITE_URL := /~${USER}/qpid-site/${TAG}
-devel-publish: devel-render
+devel-publish:
+ scripts/render ${SITE_URL} input ${OUTPUT_DIR}
chmod 755 ${OUTPUT_DIR}
rsync -av ${OUTPUT_DIR}/ ${USER}@people.apache.org:public_html/qpid-site/${TAG}
rm -rf ${OUTPUT_DIR}
-check-output-files: devel-render
+.PHONY: check-output-files
+check-output-files:
+ scripts/render "" input docs
scripts/check-output-files ${SITE_URL} input docs
+.PHONY: check-links
check-links: INTERNAL := 1
check-links: EXTERNAL := 0
-check-links: devel-render
+check-links:
+ scripts/render ${SITE_URL} input ${OUTPUT_DIR}
scripts/check-links ${SITE_URL} input ${OUTPUT_DIR} ${INTERNAL} ${EXTERNAL}
+.PHONY: clean
clean:
rm -rf ${OUTPUT_DIR}
find python -name \*.pyc -delete
+.PHONY: gen-amqp-type-reference
gen-amqp-type-reference:
scripts/gen-amqp-type-reference misc/amqp > input/amqp/type-reference.html.in
+.PHONY: gen-proton-release
gen-proton-release: gen-proton-release-page gen-proton-release-notes gen-proton-release-api-doc gen-proton-release-examples
+.PHONY: gen-dispatch-release
gen-dispatch-release: gen-dispatch-release-page gen-dispatch-release-notes gen-dispatch-release-books
+.PHONY: gen-java-release
gen-java-release: gen-java-release-page gen-java-release-notes gen-java-release-books gen-java-release-examples
+.PHONY: gen-jms-release
gen-jms-release: gen-jms-release-page gen-jms-release-notes gen-jms-release-docs
+.PHONY: gen-cpp-release
gen-cpp-release: gen-cpp-release-page gen-cpp-release-notes gen-cpp-release-api-doc gen-cpp-release-examples gen-cpp-release-books
gen-proton-release-%: RELEASE_DIR := input/releases/qpid-proton-${RELEASE}
@@ -94,5 +134,6 @@ gen-cpp-release-%: RELEASE_DIR := input/
gen-cpp-release-%:
scripts/gen-cpp-release-$* ${RELEASE} ${ISSUES_RELEASE} ${SOURCE_RELEASE} ${RELEASE_DIR} ${CHECKOUT_DIR}
+.PHONY: update-plano
update-plano:
curl "https://raw.githubusercontent.com/ssorj/plano/master/python/plano.py" -o python/plano.py
Modified: qpid/site/README
URL: http://svn.apache.org/viewvc/qpid/site/README?rev=1727462&r1=1727461&r2=1727462&view=diff
==============================================================================
--- qpid/site/README (original)
+++ qpid/site/README Fri Jan 29 00:48:58 2016
@@ -29,8 +29,10 @@ Some notable files in `input/`:
After that most everything is accomplished by running make targets.
These are the important ones:
- site$ make render # Renders input/* to output/ and docs/
+ site$ make render # Renders input/* to output/
site$ make clean # Removes output/
+ site$ make publish # Renders input/* to docs/ in preparation
+ # for a live site update
## Adding content
@@ -49,8 +51,7 @@ These are the important ones:
## Render transformations
The render step takes files under `input/` and reproduces them under
-`output/` and `docs/`. The following transformations are applied in
-the process:
+`output/`. The following transformations are applied in the process:
- `.html.in` files are wrapped in the site template and copied
- `.md` (Markdown) files are converted to HTML, wrapped in the site
@@ -167,12 +168,25 @@ on Fedora or RHEL.
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. `make render` renders to
+automatically propagated to the live site. `make publish` renders to
this same `docs/` directory.
-To publish, run `make render` and use subversion to commit the
+To publish, run `make publish` and use subversion to commit the
changes. Any additions or other structural changes under the `docs/`
-tree may require subversion adds or removes.
+directory may require subversion adds or removes.
+
+ site$ make publish
+ scripts/render "" input docs
+ svn status docs
+ M docs/index.html
+ ? docs/a-new-file.html
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ NOTICE! One more step remains!
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ Use svn to commit the changes under docs. Keep in mind that you
+ may need to svn add new files.
+ site$ svn add docs/a-new-file.html
+ site$ svn ci docs -m "A commit message"
## More information
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org