fix blockquote inside lists
Project: http://git-wip-us.apache.org/repos/asf/incubator-streams-master/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-streams-master/commit/51456fb0 Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams-master/tree/51456fb0 Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams-master/diff/51456fb0 Branch: refs/heads/master Commit: 51456fb00ea48a091f5e0bc6fb134e3ddd85b1f3 Parents: 9cb990c Author: Steve Blackmon @steveblackmon <[email protected]> Authored: Mon Apr 25 15:41:10 2016 -0500 Committer: Steve Blackmon @steveblackmon <[email protected]> Committed: Mon Apr 25 15:41:10 2016 -0500 ---------------------------------------------------------------------- src/site/markdown/release-setup.md | 28 +++++---- src/site/markdown/release.md | 82 ++++++++++++++++---------- src/site/markdown/tutorial/build.md | 14 ++--- src/site/markdown/tutorial/database.md | 8 +-- src/site/markdown/tutorial/docker.md | 2 +- src/site/markdown/tutorial/environment.md | 8 +-- src/site/markdown/website.md | 56 +++++++++--------- 7 files changed, 111 insertions(+), 87 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/51456fb0/src/site/markdown/release-setup.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/release-setup.md b/src/site/markdown/release-setup.md index a4f5d8a..bde255b 100644 --- a/src/site/markdown/release-setup.md +++ b/src/site/markdown/release-setup.md @@ -11,33 +11,35 @@ Developers using Linux workstations can skip over the references to Cygwin. If u Follow the latest steps and guides on the [ASF website](http://www.apache.org/dev/openpgp.html#generate-key) as you should **NOT** be using SHA1 and new keys **MUST** be at least 4096 bits. -> $ ssh-keygen -t rsa -b 4096 + ssh-keygen -t rsa -b 4096 Program defaults should be fine. No passphrase is required for the ssh key generation. The keys will be saved in ~/.ssh/id_dsa (private) and ~/.ssh/id_dsa.pub (public). See [Authenticating By Public Key (OpenSSH)](http://www.networknewz.com/networknewz-10-20030707AuthenticatingbyPublicKeyOpenSSH.html) for a good description on why and how to perform this task. 3. SCP your SSH public key ~/.ssh/id_dsa.pub created in last step to ~/id_dsa.pub on people.apache.org. -> $ cd ~/.ssh -> $ scp id_dsa.pub <your userid>@people.apache.org:id_dsa.pub -> $ You will be prompted for your password. + + cd ~/.ssh + scp id_dsa.pub <your userid>@people.apache.org:id_dsa.pub + +You will be prompted for your password. 4. Use ssh to login to people.apache.org -> $ cd ~ -> $ ssh <your userid>@people.apache.org + cd ~ + ssh <your userid>@people.apache.org At this point, you will still be prompted for your password. 5. Create a ~/.ssh folder in your home directory on people.apache.org and change its file mode to 700. -> $ mkdir ~/.ssh -> $ chmod 700 ~/.ssh + mkdir ~/.ssh + chmod 700 ~/.ssh 6. Move or append ~/id_dsa.pub to ~/.ssh/authorized_keys and change its file mode to 600. -> $ mv ~/id_dsa.pub ~/.ssh/authorized_keys -> $ chmod 600 ~/.ssh/authorized_keys + mv ~/id_dsa.pub ~/.ssh/authorized_keys + chmod 600 ~/.ssh/authorized_keys * *Each public key in the authorized_keys spans only one line. * For example: "ssh-dss AAAAB3NzaC1kc3MAAA ..... agBmmfZ9uAbSqA== dsa-key-20071107" @@ -46,7 +48,7 @@ Developers using Linux workstations can skip over the references to Cygwin. If u 7. Exit out of this ssh session. 8. Start a new ssh session. No login should be required this time due to the private ssh key on your local box matching up with the public ssh key in your home directory (~/.ssh). -> $ ssh <userid>@people.apache.org + ssh <userid>@people.apache.org *If you are still prompted for a password, then you have not set up the ssh keys properly. Review the steps above and ensure that all of the steps were followed properly. Or, maybe the instructions are still not quite right and they still need some adjusting. In that case, please update the instructions accordingly.* @@ -55,7 +57,7 @@ Developers using Linux workstations can skip over the references to Cygwin. If u 1. Open a shell window. If using Windows, open a cygwin window. 2. Generate a key-pair with gpg, using default key kind ("RSA and RSA") and keys size (4096). -> $ gpg --gen-key + gpg --gen-key The program's default values should be fine. For the "Real Name" enter your full name (ie. Stan Programmer). For the "e-mail address" enter your apache address (ie. [email protected]). You will also be required to enter a "passphrase" for the GPG key generation. Keep track of this as you will need this for the Release processing. @@ -65,7 +67,7 @@ Developers using Linux workstations can skip over the references to Cygwin. If u 3. Backup your home directory to another media || 4. Add your public key to the [SVN repository](https://svn.apache.org/repos/asf/incubator/streams/KEYS). See the commands describe at the beginning of this KEYS file to perform this task. The gpg key-pair is used to sign the published artifacts for the Streams releases. -> $ gpg --list-sigs <Real Name> && gpg --armor -- export <Real Name> + gpg --list-sigs <Real Name> && gpg --armor -- export <Real Name> *The [KEYS](https://svn.apache.org/repos/asf/incubator/streams/KEYS) file is updated via normal svn commit procedures. The one under w.a.o/dist/ has to be manually updated from svn.* http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/51456fb0/src/site/markdown/release.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/release.md b/src/site/markdown/release.md index 9e691ee..0896b7a 100644 --- a/src/site/markdown/release.md +++ b/src/site/markdown/release.md @@ -9,7 +9,9 @@ All of the steps below apply to both the master and project releases, unless oth 1. Environment setup for releasing artifacts (same for SNAPSHOTs and releases) 1. Increase the default Java heap available to Maven (required for Java SE 6) - > export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" + + export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" + 2. Use the latest Sun 1.7.0 JDK 3. Use Maven 3.2.1 or later 4. Make sure the [Release Setup](release-setup.html) steps have been performed. @@ -25,12 +27,17 @@ All of the steps below apply to both the master and project releases, unless oth 3. Create a release candidate branch from master. X should start at 1 and increment if early release candidates fail to complete the release cycle. -> $ git checkout master -> $ git branch {$project.version}-rcX + + git checkout master + git branch {$project.version}-rcX + 4. Verify the source has the required license headers before trying to release: -> $ mvn -P apache-release clean rat:check -e -DskipTests + + mvn -P apache-release clean rat:check -e -DskipTests + 5. Do a dry run of the release:prepare step: -> $ mvn -P apache-release release:prepare -DautoVersionSubmodules=true -DdryRun=true + + mvn -P apache-release release:prepare -DautoVersionSubmodules=true -DdryRun=true The dry run will not commit any changes back to SCM and gives you the opportunity to verify that the release process will complete as expected. You will be prompted for the following information : @@ -49,16 +56,24 @@ All of the steps below apply to both the master and project releases, unless oth 3. Verify signatures ([Verifying release signatures](#verify_signatures)) 7. Cleanup the release prepare files again: -> $ mvn -P apache-release release:clean + + mvn -P apache-release release:clean + 8. Prepare the release 1. Run the "release:prepare" step for real this time. You'll be prompted for the same version information. - > $ mvn -P apache-release -U clean release:prepare -DautoVersionSubmodules=true + + mvn -P apache-release -U clean release:prepare -DautoVersionSubmodules=true + 2. Backup (zip or tar) your local release candidate directory in case you need to rollback the release after the next step is performed. 9. Perform the release * This step will create a maven staging repository and site for use in testing and voting. - > $ mvn -Papache-release -Darguments='-Dmaven.test.skip.exec=true' release:perform -Dgoals=deploy -DlocalRepoDirectory=. -DlocalCheckout=true + + mvn -Papache-release -Darguments='-Dmaven.test.skip.exec=true' release:perform -Dgoals=deploy -DlocalRepoDirectory=. -DlocalCheckout=true + * If your local OS userid doesn't match your Apache userid, then you'll have to also override the value provided by the OS to Maven for the site-deploy step to work. This is known to work for Linux, but not for Mac and unknown for Windows.* - > -Duser.name=[your_apache_uid] + + -Duser.name=[your_apache_uid] + 10. Verify the Nexus release artifacts 1. Verify the staged artifacts in the nexus repo * https://repository.apache.org/index.html @@ -84,19 +99,23 @@ All of the steps below apply to both the master and project releases, unless oth * Staging repositories (under Build Promotion) --> Name column --> org.apache.streams * Click checkbox of the closed staging repo (org.apache.streams-XXX) and select Release. 2. Copy the source artifacts over to the distribution area -> $ svn co https://dist.apache.org/repos/dist/release/incubator/streams/releases ./streams-releases (KEEP this directory until after the release process has been completed) -> $ cd ./streams-releases -> $ mkdir ${project.version} -> $ cd ./${project.version} -> $ wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip -> $ wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.asc -> $ wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.md5 -> $ svn add ${project.name}-* -> $ svn commit -m "Committing Source Release for ${project.name}-${project.version} + + svn co https://dist.apache.org/repos/dist/release/incubator/streams/releases ./streams-releases (KEEP this directory until after the release process has been completed) + cd ./streams-releases + mkdir ${project.version} + cd ./${project.version} + wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip + wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.asc + wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.md5 + svn add ${project.name}-* + svn commit -m "Committing Source Release for ${project.name}-${project.version} + 3. Create an official release tag from the successful release candidate tag. -> $ git checkout streams-project-${project.version}-rcX -> $ git tag -a streams-project-${project.version} -m 'release tag streams-project-${project.version}' -> $ git push origin :refs/tags/streams-project-${project.version} + + git checkout streams-project-${project.version}-rcX + git tag -a streams-project-${project.version} -m 'release tag streams-project-${project.version}' + git push origin :refs/tags/streams-project-${project.version} + 4. Update the staged website * Update the downloads page to add new version using the mirrored URLs * Modify the URL for the prior release to the archived URL for the release @@ -117,15 +136,18 @@ All of the steps below apply to both the master and project releases, unless oth 1. Reply to the initial vote email and prepend to the original subject - [CANCELED] 2. Clean the release prepare files and hard reset the release candidate branch. -> mvn -P apache-release release:clean + + mvn -P apache-release release:clean 3. Delete the git tag created by the release:perform step - -> $ git tag -d streams-project-${project.version}-rcX -> $ git push origin :refs/tags/streams-project-${project.version}-rcX + + git tag -d streams-project-${project.version}-rcX + git push origin :refs/tags/streams-project-${project.version}-rcX 4. Delete the build artifacts on people & www -> $ rm -rfv /www/people.apache.org/builds/streams/${project.version} -> $ rm -rfv /www/www.apache.org/dist/streams/${project.version} + + rm -rfv /www/people.apache.org/builds/streams/${project.version} + rm -rfv /www/www.apache.org/dist/streams/${project.version} 5. Drop the nexus staging repo 1. https://repository.apache.org/index.html @@ -139,10 +161,10 @@ All of the steps below apply to both the master and project releases, unless oth ####Verifying release signatures On unix platforms the following command can be executed - -> for file in `find . -type f -iname '*.asc'` -> do -> gpg --verify ${file} -> done + for file in `find . -type f -iname '*.asc'` + do + gpg --verify ${file} + done You'll need to look at the output to ensure it contains only good signatures - http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/51456fb0/src/site/markdown/tutorial/build.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/tutorial/build.md b/src/site/markdown/tutorial/build.md index a51f2c2..37ef3fd 100644 --- a/src/site/markdown/tutorial/build.md +++ b/src/site/markdown/tutorial/build.md @@ -56,24 +56,24 @@ See [streams-project-index.html](http://streams.incubator.apache.org/site/0.2-in Run from your command line: -> git clone https://github.com/apache/incubator-streams -> git clone https://github.com/apache/incubator-streams-examples + git clone https://github.com/apache/incubator-streams + git clone https://github.com/apache/incubator-streams-examples ### Build Projects Run from your command line: -> export MAVEN_OPTS="-Xmx2G" -> cd incubator-streams -> mvn clean install -Dmaven.test.skip.exec=true + export MAVEN_OPTS="-Xmx2G" + cd incubator-streams + mvn clean install -Dmaven.test.skip.exec=true | Possible result | Explanation | |-----------------|-------------| | BUILD SUCCESSFUL | You are all good | | BUILD FAILED | Check yourself | -> cd ../incubator-streams-examples -> mvn clean package + cd ../incubator-streams-examples + mvn clean package | Possible result | Explanation | |-----------------|-------------| http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/51456fb0/src/site/markdown/tutorial/database.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/tutorial/database.md b/src/site/markdown/tutorial/database.md index 5564ee8..9dc1b69 100644 --- a/src/site/markdown/tutorial/database.md +++ b/src/site/markdown/tutorial/database.md @@ -8,7 +8,7 @@ We'll assume you've got docker up and running. Run from your command line: -> $ docker ps + docker ps If you see a (possibly empty) list of running containers, you are good. @@ -16,12 +16,12 @@ If you see a (possibly empty) list of running containers, you are good. Elasticsearch is a great database for storing content from your streams. -> $ docker run -d --name elasticsearch elasticsearch + docker run -d --name elasticsearch elasticsearch ### Add Elasticsearch container details to your configuration -> cd $STREAMS -> export DOCKERHOST=$(docker-machine ip) + cd $STREAMS + export DOCKERHOST=$(docker-machine ip) Put the following into elasticsearch.conf http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/51456fb0/src/site/markdown/tutorial/docker.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/tutorial/docker.md b/src/site/markdown/tutorial/docker.md index 2f71e4d..84fc6cb 100644 --- a/src/site/markdown/tutorial/docker.md +++ b/src/site/markdown/tutorial/docker.md @@ -12,7 +12,7 @@ We'll assume you've got docker up and running. Run from your command line: -> $ docker ps + docker ps If you see a (possibly empty) list of running containers, you are good. http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/51456fb0/src/site/markdown/tutorial/environment.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/tutorial/environment.md b/src/site/markdown/tutorial/environment.md index 64bb050..1a50a28 100644 --- a/src/site/markdown/tutorial/environment.md +++ b/src/site/markdown/tutorial/environment.md @@ -4,13 +4,13 @@ Pick a place on your file system that's easy to remember and reference with an a Create a new empty folder there and export the path to a variables. -> $ mkdir ~/streams -> $ export STREAMS=$(cd ~streams; pwd) + mkdir ~/streams + export STREAMS=$(cd ~streams; pwd) ### Create a configuration file to hold secrets -> $ cd $STREAMS -> $ touch reference.conf + cd $STREAMS + touch reference.conf To get started, put the following into reference.conf http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/51456fb0/src/site/markdown/website.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/website.md b/src/site/markdown/website.md index cca00a5..65826ea 100644 --- a/src/site/markdown/website.md +++ b/src/site/markdown/website.md @@ -42,9 +42,17 @@ Currently pushing website changes is a manual process performed by whomever is m This typically requires checking out the current website from SVN. - `svn co https://svn.apache.org/repos/infra/websites/production/streams/content` - `cd content` - + svn co https://svn.apache.org/repos/infra/websites/production/streams/content + cd content + +NOTE: + +Repositories should always be built and published in the following order: + +* streams-master +* streams-project +* streams-examples + #### Preparing to publishing a new website version The instructions below presume: @@ -54,33 +62,27 @@ The instructions below presume: If this is a brand new snapshot or release version, you first need to create a directory corresponding to the new version. -> content$ mkdir site/${project.version} -> content$ svn add site/${project.version} -> content$ svn commit -m "svn add site/${project.version}" + mkdir site/${project.version} + svn add site/${project.version} + svn commit -m "svn add site/${project.version}" The first time a specific site is being published for this version, you must create the directory where it will be published. -> content$ mkdir site/${project.version}/${project.artifactId} -> content$ svn add site/${project.version}/${project.artifactId} -> content$ svn commit -m "svn add site/${project.version}/${project.artifactId}" + mkdir site/${project.version}/${project.artifactId} + svn add site/${project.version}/${project.artifactId} + svn commit -m "svn add site/${project.version}/${project.artifactId}" If you are published over an existing snapshot, you must first remove the existing version and recreate an empty directory. -> content$ rm -rf site/${project.version}/${project.artifactId} -> content$ svn delete site/${project.version}/${project.artifactId} -> content$ svn commit -m "svn delete site/${project.version}/${project.artifactId}" -> content$ mkdir site/${project.version}/${project.artifactId} -> content$ svn add site/${project.version}/${project.artifactId} -> content$ svn commit -m "svn add site/${project.version}/${project.artifactId}" + rm -rf site/${project.version}/${project.artifactId} + svn delete site/${project.version}/${project.artifactId} + svn commit -m "svn delete site/${project.version}/${project.artifactId}" + mkdir site/${project.version}/${project.artifactId} + svn add site/${project.version}/${project.artifactId} + svn commit -m "svn add site/${project.version}/${project.artifactId}" The folder must exist and be empty for the publish steps to succeed. -Repositories should always be built and published in the following order: - -* streams-master -* streams-project -* streams-examples - #### Generating and publishing a new website version The instructions below presume: @@ -102,23 +104,21 @@ First, ensure that you have local credentials capable of publishing the site. Next, generate SVG resources for all DOT diagrams in the source tree -> $ for dot in $(find . -name *.dot); do dot -Tsvg $dot -o $dot.svg; done + for dot in $(find . -name *.dot); do dot -Tsvg $dot -o $dot.svg; done Then, generate the site that will be published -> $ mvn clean site:site site:stage + mvn clean site:site site:stage At this point you can open target/staging/index.html and do a sanity check on the site you intend to publish. Finally, publish the site. -> $ mvn scm-publish:publish-scm -Dscmpublish.pubScmUrl=scm:svn:https://svn.apache.org/repos/infra/websites/production/streams/content/site/${project.version}/${project.artifactId} + mvn scm-publish:publish-scm -Dscmpublish.pubScmUrl=scm:svn:https://svn.apache.org/repos/infra/websites/production/streams/content/site/${project.version}/${project.artifactId} Note the revision number checked in at the bottom of the maven logs. -You should now be able to access the published site(s) via an absolute URL. - - http://streams.incubator.apache.org/site/${project.version}/${project.artifactId} +You should now be able to access the published site(s) via an absolute URL such as http://streams.incubator.apache.org/site/${project.version}/${project.artifactId} For example, website documentation from a recent release: @@ -152,7 +152,7 @@ If you are promoting sites from all streams repositories simultaneously, the fil Redirect /site/latest/ /site/${project.version} -If you want to publish sites at different versions across streams repositories, configure as follows: +If you want to expose sites hosted under different versions across streams repositories: Redirect /site/latest/streams-master /site/0.3-incubating-SNAPSHOT/streams-master Redirect /site/latest/streams-project /site/0.2-incubating/streams-project
