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/09/06 17:30:32 UTC
qpid-site git commit: QPID-7350: Use the .md suffix for the site
README
Repository: qpid-site
Updated Branches:
refs/heads/asf-site eff0fe555 -> 0baa8f49a
QPID-7350: Use the .md suffix for the site README
Project: http://git-wip-us.apache.org/repos/asf/qpid-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-site/commit/0baa8f49
Tree: http://git-wip-us.apache.org/repos/asf/qpid-site/tree/0baa8f49
Diff: http://git-wip-us.apache.org/repos/asf/qpid-site/diff/0baa8f49
Branch: refs/heads/asf-site
Commit: 0baa8f49a43f07e3e494d4da3dcf93632ae3a753
Parents: eff0fe5
Author: Justin Ross <jr...@apache.org>
Authored: Tue Sep 6 10:30:19 2016 -0700
Committer: Justin Ross <jr...@apache.org>
Committed: Tue Sep 6 10:30:19 2016 -0700
----------------------------------------------------------------------
README | 207 --------------------------------------------
README.md | 207 ++++++++++++++++++++++++++++++++++++++++++++
content/dashboard.html | 2 +-
input/dashboard.md | 2 +-
4 files changed, 209 insertions(+), 209 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/0baa8f49/README
----------------------------------------------------------------------
diff --git a/README b/README
deleted file mode 100644
index 98cb9c7..0000000
--- a/README
+++ /dev/null
@@ -1,207 +0,0 @@
-# Qpid Site
-
-## Setup your environment
-
-To setup paths in your environment, source the `config.sh` script.
-
- ~$ cd qpid-site/
- [qpid-site]$ source config.sh
-
-## Project layout
-
- config.sh # Sets up your project environment
- Makefile # Defines the make targets
- python/ # Python library code; used by scripts
- scripts/ # Scripts called by the make rules
- input/ # The site content before rendering
- output/ # Rendered result for local testing
- content/ # Rendered result for publication to the site
-
-Some notable files in `input/`:
-
- input/_transom_template.html # The standard page template
- input/_transom_config.py # Site variables, values for {{placeholders}}
- input/site.js # Site javascript code
- input/site.css # Site CSS
-
-## Make targets
-
-After that most everything is accomplished by running make targets.
-These are the important ones:
-
- [qpid-site]$ make render # Renders input/* to output/
- [qpid-site]$ make clean # Removes output/
- [qpid-site]$ make publish # Renders input/* to content/ in preparation
- # for a live site update
-
-## Adding content
-
-1. Use your editor to create or edit a file under `input/`
-
- [qpid-site]$ emacs input/somepage.md
-
-2. Render the site
-
- [qpid-site]$ make render
-
-3. To look at the result in your browser, navigate to
-
- file:///$somepath/site/output/somepage.html
-
-## Render transformations
-
-The render step takes files under `input/` and reproduces them under
-`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
- template, and copied
- - All other files are simply copied
- - All Markdown, HTML, Javascript, and CSS files undergo substitution
- for `{{placeholders}}`
-
-## Markdown syntax
-
-Markdown is a markup language inspired by plain text conventions.
-This page is written in markdown. See this [syntax guide][syntax].
-
-The particular markdown implementation the site code uses is
-[python-markdown2][markdown2].
-
-I personally benefit from using [emacs markdown mode][emacs]. On
-Fedora it is part of the `emacs-goodies` package.
-
-[syntax]: http://daringfireball.net/projects/markdown/syntax
-[markdown2]: https://github.com/trentm/python-markdown2
-[emacs]: http://jblevins.org/projects/markdown-mode/
-
-## Placeholders
-
-`input/_transom_config.py` defines some variables usable for any input
-page. To illustrate:
-
- {{site_url}} -> http://qpid.apache.org
- {{current_release}} -> 0.20
- {{current_proton_release}} -> 0.4
- {{current_dispatch_release}} -> 0.1
-
-Under `output/`, `{{site_url}}` is set to a path in your development
-environment, to allow for local testing. Under `content/`,
-`{{site_url}}` is set to <http://qpid.apache.org>, for publication to
-the live site.
-
-You can see more definitions in `input/_transom_config.py`.
-
-## Style guide
-
-See <http://qpid.apache.org/site.html#style-guide> for site guidelines
-for formatting and style.
-
-## Checking links
-
-The site tools offer a way to check that all your hyperlinks are
-working.
-
- # Usage: make check-links [INTERNAL=1] [EXTERNAL=0]
-
- # Check internal links only
- [qpid-site]$ make check-links
-
- # Check external links as well
- [qpid-site]$ make check-links EXTERNAL=1
-
-## Generating release content
-
-Most of the site content is written by human beings. Release content,
-however, is automated. Use the following commands to generate content
-for a new release.
-
- # Usage: make gen-$module-release RELEASE=$VERSION [CHECKOUT_DIR=$DIR]
-
- # For new Qpid C++ releases
- [qpid-site]$ make gen-cpp-release RELEASE=$VERSION
-
- # For new Qpid Java releases
- [qpid-site]$ make gen-java-release RELEASE=$VERSION
-
- # For new Qpid JMS releases
- [qpid-site]$ make gen-jms-release RELEASE=$VERSION
-
- # For new Qpid Proton releases
- [qpid-site]$ make gen-proton-release RELEASE=$VERSION
-
- # For new Qpid Dispatch releases
- [qpid-site]$ make gen-dispatch-release RELEASE=$VERSION
-
-These will produce a new tree of release content under
-`input/releases/`. The content includes API docs, examples, and
-books. Once generated, you can make any edits you'd like and check it
-in.
-
-In addition to specifying `RELEASE`, you can override the particular
-release identifier used for querying issues and exporting source using
-`ISSUES_RELEASE` and `SOURCE_RELEASE` respectively. If not set,
-`ISSUES_RELEASE` and `SOURCE_RELEASE` take the value of `RELEASE`.
-
-By default, the scripts will fetch the source for you based on the
-release script inputs. By setting the optional `CHECKOUT_DIR`
-parameter to the location of a local Subversion checkout, the scripts
-will instead use the provided content.
-
-When you add release content, you should also update the following
-files:
-
- input/_transom_config.py # Update the current release pointer
- input/releases/index.md # Add current release, move the previous
-
-The scripts depend on the availability of the following tools in your
-environment: cmake, dot, doxygen, epydoc, fop, gcc, javadoc, make,
-pygments, PyYAML, rdoc, git, pandoc, pdflatex and xsltproc. The
-following yum command works to install all the required dependencies
-on Fedora or RHEL.
-
- $ sudo yum install cmake doxygen epydoc fop gcc graphviz java-devel \
- libxslt make python-pygments PyYAML rubygem-rdoc git \
- pandoc-pdf python-sphinx apache-maven
-
-## Publishing your work
-
-Qpid uses gitpubsub to send new content to the Qpid website. Any file
-committed under the 'content' dir on the 'asf-site' branch of the
-https://git-wip-us.apache.org/repos/asf/qpid-site.git repo is
-automatically propagated to the live site. `make publish` renders to
-this same `content/` directory.
-
-To publish, run `make publish` and use git to commit and push the
-changes. Any additions or other structural changes under the `input/` and
-`content/` directories may require git adds or removes.
-
- [qpid-site]$ make publish
- scripts/render "" input content
- git status input content
- # On branch asf-site
- # Changes not staged for commit:
- # (use "git add <file>..." to update what will be committed)
- # (use "git checkout -- <file>..." to discard changes in working directory)
- #
- # modified: content/discussion.html
- # modified: input/discussion.md
- #
- # Untracked files:
- # (use "git add <file>..." to include in what will be committed)
- #
- # content/new_file.html
- # input/new_file.md
- no changes added to commit (use "git add" and/or "git commit -a")
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- NOTICE! One more step remains!
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Use git to commit and push the changes.
- Keep in mind that you may need to git add new files.
- Also keep in mind to git rm matching files from content/ that have been removed from input/.
-
-
-## More information
-
- - The Qpid site code internally uses
- [Transom](http://www.ssorj.net/projects/transom.html)
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/0baa8f49/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..98cb9c7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,207 @@
+# Qpid Site
+
+## Setup your environment
+
+To setup paths in your environment, source the `config.sh` script.
+
+ ~$ cd qpid-site/
+ [qpid-site]$ source config.sh
+
+## Project layout
+
+ config.sh # Sets up your project environment
+ Makefile # Defines the make targets
+ python/ # Python library code; used by scripts
+ scripts/ # Scripts called by the make rules
+ input/ # The site content before rendering
+ output/ # Rendered result for local testing
+ content/ # Rendered result for publication to the site
+
+Some notable files in `input/`:
+
+ input/_transom_template.html # The standard page template
+ input/_transom_config.py # Site variables, values for {{placeholders}}
+ input/site.js # Site javascript code
+ input/site.css # Site CSS
+
+## Make targets
+
+After that most everything is accomplished by running make targets.
+These are the important ones:
+
+ [qpid-site]$ make render # Renders input/* to output/
+ [qpid-site]$ make clean # Removes output/
+ [qpid-site]$ make publish # Renders input/* to content/ in preparation
+ # for a live site update
+
+## Adding content
+
+1. Use your editor to create or edit a file under `input/`
+
+ [qpid-site]$ emacs input/somepage.md
+
+2. Render the site
+
+ [qpid-site]$ make render
+
+3. To look at the result in your browser, navigate to
+
+ file:///$somepath/site/output/somepage.html
+
+## Render transformations
+
+The render step takes files under `input/` and reproduces them under
+`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
+ template, and copied
+ - All other files are simply copied
+ - All Markdown, HTML, Javascript, and CSS files undergo substitution
+ for `{{placeholders}}`
+
+## Markdown syntax
+
+Markdown is a markup language inspired by plain text conventions.
+This page is written in markdown. See this [syntax guide][syntax].
+
+The particular markdown implementation the site code uses is
+[python-markdown2][markdown2].
+
+I personally benefit from using [emacs markdown mode][emacs]. On
+Fedora it is part of the `emacs-goodies` package.
+
+[syntax]: http://daringfireball.net/projects/markdown/syntax
+[markdown2]: https://github.com/trentm/python-markdown2
+[emacs]: http://jblevins.org/projects/markdown-mode/
+
+## Placeholders
+
+`input/_transom_config.py` defines some variables usable for any input
+page. To illustrate:
+
+ {{site_url}} -> http://qpid.apache.org
+ {{current_release}} -> 0.20
+ {{current_proton_release}} -> 0.4
+ {{current_dispatch_release}} -> 0.1
+
+Under `output/`, `{{site_url}}` is set to a path in your development
+environment, to allow for local testing. Under `content/`,
+`{{site_url}}` is set to <http://qpid.apache.org>, for publication to
+the live site.
+
+You can see more definitions in `input/_transom_config.py`.
+
+## Style guide
+
+See <http://qpid.apache.org/site.html#style-guide> for site guidelines
+for formatting and style.
+
+## Checking links
+
+The site tools offer a way to check that all your hyperlinks are
+working.
+
+ # Usage: make check-links [INTERNAL=1] [EXTERNAL=0]
+
+ # Check internal links only
+ [qpid-site]$ make check-links
+
+ # Check external links as well
+ [qpid-site]$ make check-links EXTERNAL=1
+
+## Generating release content
+
+Most of the site content is written by human beings. Release content,
+however, is automated. Use the following commands to generate content
+for a new release.
+
+ # Usage: make gen-$module-release RELEASE=$VERSION [CHECKOUT_DIR=$DIR]
+
+ # For new Qpid C++ releases
+ [qpid-site]$ make gen-cpp-release RELEASE=$VERSION
+
+ # For new Qpid Java releases
+ [qpid-site]$ make gen-java-release RELEASE=$VERSION
+
+ # For new Qpid JMS releases
+ [qpid-site]$ make gen-jms-release RELEASE=$VERSION
+
+ # For new Qpid Proton releases
+ [qpid-site]$ make gen-proton-release RELEASE=$VERSION
+
+ # For new Qpid Dispatch releases
+ [qpid-site]$ make gen-dispatch-release RELEASE=$VERSION
+
+These will produce a new tree of release content under
+`input/releases/`. The content includes API docs, examples, and
+books. Once generated, you can make any edits you'd like and check it
+in.
+
+In addition to specifying `RELEASE`, you can override the particular
+release identifier used for querying issues and exporting source using
+`ISSUES_RELEASE` and `SOURCE_RELEASE` respectively. If not set,
+`ISSUES_RELEASE` and `SOURCE_RELEASE` take the value of `RELEASE`.
+
+By default, the scripts will fetch the source for you based on the
+release script inputs. By setting the optional `CHECKOUT_DIR`
+parameter to the location of a local Subversion checkout, the scripts
+will instead use the provided content.
+
+When you add release content, you should also update the following
+files:
+
+ input/_transom_config.py # Update the current release pointer
+ input/releases/index.md # Add current release, move the previous
+
+The scripts depend on the availability of the following tools in your
+environment: cmake, dot, doxygen, epydoc, fop, gcc, javadoc, make,
+pygments, PyYAML, rdoc, git, pandoc, pdflatex and xsltproc. The
+following yum command works to install all the required dependencies
+on Fedora or RHEL.
+
+ $ sudo yum install cmake doxygen epydoc fop gcc graphviz java-devel \
+ libxslt make python-pygments PyYAML rubygem-rdoc git \
+ pandoc-pdf python-sphinx apache-maven
+
+## Publishing your work
+
+Qpid uses gitpubsub to send new content to the Qpid website. Any file
+committed under the 'content' dir on the 'asf-site' branch of the
+https://git-wip-us.apache.org/repos/asf/qpid-site.git repo is
+automatically propagated to the live site. `make publish` renders to
+this same `content/` directory.
+
+To publish, run `make publish` and use git to commit and push the
+changes. Any additions or other structural changes under the `input/` and
+`content/` directories may require git adds or removes.
+
+ [qpid-site]$ make publish
+ scripts/render "" input content
+ git status input content
+ # On branch asf-site
+ # Changes not staged for commit:
+ # (use "git add <file>..." to update what will be committed)
+ # (use "git checkout -- <file>..." to discard changes in working directory)
+ #
+ # modified: content/discussion.html
+ # modified: input/discussion.md
+ #
+ # Untracked files:
+ # (use "git add <file>..." to include in what will be committed)
+ #
+ # content/new_file.html
+ # input/new_file.md
+ no changes added to commit (use "git add" and/or "git commit -a")
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ NOTICE! One more step remains!
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ Use git to commit and push the changes.
+ Keep in mind that you may need to git add new files.
+ Also keep in mind to git rm matching files from content/ that have been removed from input/.
+
+
+## More information
+
+ - The Qpid site code internally uses
+ [Transom](http://www.ssorj.net/projects/transom.html)
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/0baa8f49/content/dashboard.html
----------------------------------------------------------------------
diff --git a/content/dashboard.html b/content/dashboard.html
index 469bfca..5328fe0 100644
--- a/content/dashboard.html
+++ b/content/dashboard.html
@@ -182,7 +182,7 @@ https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/>
<td><a href="https://git-wip-us.apache.org/repos/asf/qpid-proton.git">Git</a>, <a href="https://github.com/apache/qpid-proton">GitHub mirror</a></td>
</tr>
<tr>
- <td><a href="https://git-wip-us.apache.org/repos/asf?p=qpid-site.git;a=blob_plain;f=README;hb=HEAD">Website</a></td>
+ <td><a href="https://git-wip-us.apache.org/repos/asf?p=qpid-site.git;a=blob_plain;f=README.md;hb=HEAD">Website</a></td>
<td><a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20QPID%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20Website%20ORDER%20BY%20priority%20DESC">Open issues</a> — <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310520&issuetype=1&components=12312307&summary=[Enter%20a%20brief%20description]&priority=3">New bug</a> — <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310520&issuetype=4&components=12312307&summary=[Enter%20a%20brief%20description]&priority=3">New improvement</a></td>
<td>-</td>
<td><a href="https://git-wip-us.apache.org/repos/asf/qpid-site.git">Git</a></td>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/0baa8f49/input/dashboard.md
----------------------------------------------------------------------
diff --git a/input/dashboard.md b/input/dashboard.md
index 2559104..2e96c38 100644
--- a/input/dashboard.md
+++ b/input/dashboard.md
@@ -27,7 +27,7 @@
| [Dispatch]({{site_url}}/components/dispatch-router/index.html) | [Open issues](https://issues.apache.org/jira/issues/?jql=project%20%3D%20DISPATCH%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC) — [New bug](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12315321&issuetype=1&summary=[Enter%20a%20brief%20description]&priority=3) — [New improvement](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12315321&issuetype=4&summary=[Enter%20a%20brief%20description]&priority=3) | - | [Git](https://git-wip-us.apache.org/repos/asf/qpid-dispatch.git), [GitHub mirror](https://github.com/apache/qpid-dispatch) |
| [JMS]({{site_url}}/components/jms/index.html) | [Open issues](https://issues.apache.org/jira/issues/?jql=project%20%3D%20QPIDJMS%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC) — [New bug](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12314524&issuetype=1&summary=[Enter%20a%20brief%20description]&priority=3) — [New improvement](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12314524&issuetype=4&summary=[Enter%20a%20brief%20description]&priority=3) | [Java 7](https://builds.apache.org/view/M-R/view/Qpid/job/Qpid-JMS-Test-JDK7/), [Java 8](https://builds.apache.org/view/M-R/view/Qpid/job/Qpid-JMS-Test-JDK8/) | [Git](https://git-wip-us.apache.org/repos/asf/qpid-jms.git), [GitHub mirror](https://github.com/apache/qpid-jms) |
| [Proton]({{site_url}}/proton/index.html) | [Open issues](https://issues.apache.org/jira/issues/?jql=project%20%3D%20PROTON%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC) — [New bug](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12313720&issuetype=1&summary=[Enter%20a%20brief%20description]&priority=3) — [New improvement](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12313720&issuetype=4&summary=[Enter%20a%20brief%20description]&priority=3) | [C](https://builds.apache.org/view/M-R/view/Qpid/job/Qpid-proton-c/), [Java](https://builds.apache.org/view/M-R/view/Qpid/job/Qpid-proton-j/) | [Git](https://git-wip-us.apache.org/repos/asf/qpid-proton.git), [GitHub mirror](https://github.com/apache/qpid-proton) |
-| [Website](https://git-wip-us.apache.org/repos/asf?p=qpid-site.git;a=blob_plain;f=README;hb=HEAD) | [Open issues](https://issues.apache.org/jira/issues/?jql=project%20%3D%20QPID%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20Website%20ORDER%20BY%20priority%20DESC) — [New bug](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310520&issuetype=1&components=12312307&summary=[Enter%20a%20brief%20description]&priority=3) — [New improvement](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310520&issuetype=4&components=12312307&summary=[Enter%20a%20brief%20description]&priority=3) | - | [Git](https://git-wip-us.apache.org/repos/asf/qpid-site.git) |
+| [Website](https://git-wip-us.apache.org/repos/asf?p=qpid-site.git;a=blob_plain;f=README.md;hb=HEAD) | [Open issues](https://issues.apache.org/jira/issues/?jql=project%20%3D%20QPID%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20Website%20ORDER%20BY%20priority%20DESC) — [New bug](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310520&issuetype=1&components=12312307&summary=[Enter%20a%20brief%20description]&priority=3) — [New improvement](https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310520&issuetype=4&components=12312307&summary=[Enter%20a%20brief%20description]&priority=3) | - | [Git](https://git-wip-us.apache.org/repos/asf/qpid-site.git) |
</div>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org