Repository: accumulo-website Updated Branches: refs/heads/asf-site a0a66d3ea -> 459ae60a2 refs/heads/master 8d90110ea -> 3afe129f3
Update release guide for documentation Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/3afe129f Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/3afe129f Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/3afe129f Branch: refs/heads/master Commit: 3afe129f3b560793d06cf015bc0629b7a2874845 Parents: 8d90110 Author: Mike Walch <mwa...@apache.org> Authored: Wed Jun 7 09:58:06 2017 -0400 Committer: Mike Walch <mwa...@apache.org> Committed: Wed Jun 7 09:58:06 2017 -0400 ---------------------------------------------------------------------- contributor/making-release.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/3afe129f/contributor/making-release.md ---------------------------------------------------------------------- diff --git a/contributor/making-release.md b/contributor/making-release.md index 1c49c7c..9055976 100644 --- a/contributor/making-release.md +++ b/contributor/making-release.md @@ -111,7 +111,7 @@ Fill out the [add release][addrelease] form to update the projects website. ## Update the Accumulo project website -After a successful vote, this website needs to be updated with the new artifacts. +After a successful vote, [this website][website-repo] needs to be updated with the new artifacts. * Update downloads page * Create a post in `_posts/release/` containing release notes (ensure notes contain link to JIRA changes for that version) @@ -120,9 +120,20 @@ After a successful vote, this website needs to be updated with the new artifacts ### Documentation +Starting with 2.0.0, the source code for the Accumulo documentation was moved to the [accumulo-website repo][website-repo] except +for two markdown files that should be changed in the Accumulo repo and copied/mirrored to the website repo for releases. + +1. `INSTALL.md` is mirrored from Accumulo repo using a tool like `meld`. + + meld /path/to/accumulo/INSTALL.md /path/to/accumulo-website/_docs-2-x/getting-started/quick-install.md + +2. `configuration-properties` is copied after it is generated by the Accumulo build. + + cp /path/to/accumulo/core/target/generated-docs/configuration-properties.md /path/to/accumulo-website/_docs-2-x/administration/configuration-properties.md + **For 2.x minor releases,** follow the steps below: -1. Create a new documentation collection for the new minor release (i.e `2.0`) using the unreleased collection. Avoid using a dot `.` in directory name: +1. Create a new documentation collection for the new minor release (i.e `2.0`) using the unreleased collection. Avoid using a dot `.` in the directory name: cp -r _docs-unreleased _docs-2-0 @@ -134,12 +145,13 @@ After a successful vote, this website needs to be updated with the new artifacts 3. Point Jekyll to the new documentation collection by modifying `collections` and `defaults` in `_config.yml`. Follow what was done for previous releases. +4. Copy `configuration-properties` and mirror `INSTALL.md`. + Once a collection is created for a 2.x minor release, developers can make documentation updates like normal website updates. -**For 2.x bugfix releases,** nothing needs to be done. +**For 2.x bugfix releases,** copy `configuration-properties` and mirror `INSTALL.md`. -**For 1.x minor & bugfix releases,** copy and commit the `accumulo_user_manual.html` generated for release to the `1.x/` directory in -Accumulo website repo. +**For 1.x minor & bugfix releases,** copy `accumulo_user_manual.html` generated for release to the `1.x/` directory in the [accumulo-website repo][website-repo]. ### Javadocs @@ -185,3 +197,4 @@ Some good references that explain a few things: [addrelease]: https://reporter.apache.org/addrelease?accumulo [verify]: {{ "/contributor/verifying-release" | relative_url }} [examples]: https://github.com/apache/accumulo-examples +[website-repo]: https://github.com/apache/accumulo-website
