GEODE-1952 Add book README; edit docs README, CONTRIBUTE
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/0b312759 Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/0b312759 Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/0b312759 Branch: refs/heads/develop Commit: 0b31275966beaf4039afd913b8644c81a32c1758 Parents: 36d1f39 Author: Joey McAllister <jmcallis...@pivotal.io> Authored: Tue Oct 11 17:29:12 2016 -0700 Committer: Joey McAllister <jmcallis...@pivotal.io> Committed: Tue Oct 11 17:29:12 2016 -0700 ---------------------------------------------------------------------- geode-book/README.md | 1 + geode-docs/CONTRIBUTE.md | 10 +++++----- geode-docs/README.md | 9 +-------- 3 files changed, 7 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/0b312759/geode-book/README.md ---------------------------------------------------------------------- diff --git a/geode-book/README.md b/geode-book/README.md new file mode 100644 index 0000000..a1c1602 --- /dev/null +++ b/geode-book/README.md @@ -0,0 +1 @@ +For information about writing, editing, building, and publishing the Apache Geode documentation, please view the `README.md` and `CONTRIBUTING.md` files in the `geode-docs` directory. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/0b312759/geode-docs/CONTRIBUTE.md ---------------------------------------------------------------------- diff --git a/geode-docs/CONTRIBUTE.md b/geode-docs/CONTRIBUTE.md index dd97f47..7345cb3 100644 --- a/geode-docs/CONTRIBUTE.md +++ b/geode-docs/CONTRIBUTE.md @@ -12,10 +12,10 @@ Project Geode welcomes your contributions to the community's documentation effor We use the fork-and-pull collaboration method on GitHub: -1. In your GitHub account, fork the gemfire/docs-geode-md repository. +1. In your GitHub account, fork the `apache/incubator-geode` repository. 2. Create a local clone of your fork. -3. Make changes and commit them in your fork. -4. In the gemfire/docs-geode-md repository, create a pull request. +3. Make changes in the `geode-docs` directory and commit them in your fork. +4. In the `apache/incubator-geode` repository, create a pull request. See [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) on GitHub for more about the fork-and-pull collaboration method. @@ -23,7 +23,7 @@ See [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) ## Document Source Files and Tools -Project Geode documentation source files are written in markdown. Image files include .gif and .png graphics and editable image files in the open source SVG format. +Project Geode documentation source files are written in markdown. Image files include .gif and .png graphics and editable image files in the open-source SVG format. - [Working with Markdown Files](#markdown) - [Working with Images and Graphics](#images) @@ -38,7 +38,7 @@ You can edit markdown files in any text editor. For more, read [Daring Fireball' ### Working with Images and Graphics -Image files in .gif or .png format are in the `images` directory in the Project Geode docs repo. Images in .svg format are in the `images_svg` directory. +Image files in .gif or .png format are in the `docs/images` directory in the Project Geode docs repo. Images in .svg format are in the `docs/images_svg` directory. Most of the Project Geode image files have been converted to the open source SVG format. You can insert SVG images directly into an XML topic and modify images using a SVG editor. http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/0b312759/geode-docs/README.md ---------------------------------------------------------------------- diff --git a/geode-docs/README.md b/geode-docs/README.md index bc70325..199906e 100644 --- a/geode-docs/README.md +++ b/geode-docs/README.md @@ -4,12 +4,11 @@ Apache Geode provides the full source for end-user documentation in markdown for Bookbinder is a gem that binds a unified documentation web application from markdown, html, and/or DITA source material. The source material for bookbinder must be stored either in local directories or in GitHub repositories. Bookbinder runs [middleman](http://middlemanapp.com/) to produce a Rackup app that can be deployed locally or as a Web application. -This document contains instructions for building and viewing the Geode documentation locally, as well as for publishing it to the Geode website. It contains the sections: +This document contains instructions for building and viewing the Geode documentation locally. - [Prerequisites](#prereq) - [Bookbinder Usage](#usage) - [Building the Documentation](#building) -- [Publishing the Documentation](#publishing) ## Prerequisites @@ -75,9 +74,3 @@ broken_link_exclusions: iefix|using_custom_classes|arrowhead|cppdocs|DotNetDocs ``` You can now view the local documentation at <http://localhost:9292>. - -## Publishing the Documentation - -Because the `final_app` directory contains the full output of the HTML conversion process, you can easily publish this directory as a hosted Web application. - -To publish the Geode documentation you built locally to the Geode website, move the contents of the directory `geode-book/final_app/public/docs` to the directory `geode-site/website/content/docs`. Then, follow the instructions for updating the website located at `geode-site/website/README.md`. \ No newline at end of file
