GEODE-1952: Change Project G to Apache G; other edits
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/131e99ee Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/131e99ee Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/131e99ee Branch: refs/heads/feature/GEODE-1952-3 Commit: 131e99eeb7e2971f0aa51ffdf23624138cca5652 Parents: d8afffb Author: Joey McAllister <jmcallis...@pivotal.io> Authored: Wed Oct 12 17:56:09 2016 -0700 Committer: Karen Miller <kmil...@pivotal.io> Committed: Fri Oct 14 14:51:03 2016 -0700 ---------------------------------------------------------------------- geode-docs/CONTRIBUTE.md | 48 +++++++++---------------------------------- geode-docs/README.md | 2 +- 2 files changed, 11 insertions(+), 39 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/131e99ee/geode-docs/CONTRIBUTE.md ---------------------------------------------------------------------- diff --git a/geode-docs/CONTRIBUTE.md b/geode-docs/CONTRIBUTE.md index 7345cb3..979474e 100644 --- a/geode-docs/CONTRIBUTE.md +++ b/geode-docs/CONTRIBUTE.md @@ -1,54 +1,26 @@ -# Contributing to the Project Geode Documentation +# Contributing to the Apache Geode Documentation -Project Geode welcomes your contributions to the community's documentation efforts. You can participate by writing new content, reviewing and editing existing content, or fixing bugs. This document covers the following topics: +Apache Geode welcomes your contributions to the community's documentation efforts. You can participate by writing new content, reviewing and editing existing content, or fixing bugs. This document covers the following topics: -- [How to Contribute](#contribute) -- [Document Source Files and Tools](#source_tools) -- [Writing Guidelines](#guidelines) +- [Working with Markdown Files](#working-with-markdown-files) +- [Working with Images and Graphics](#working-with-images-and-graphics) +- [Writing Guidelines](#writing-guidelines) -[]() - -## How to Contribute - -We use the fork-and-pull collaboration method on GitHub: - -1. In your GitHub account, fork the `apache/incubator-geode` repository. -2. Create a local clone of your fork. -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. - -[]() - -## 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. - -- [Working with Markdown Files](#markdown) -- [Working with Images and Graphics](#images) - -[]() - -### Working with Markdown Files +## Working with Markdown Files You can edit markdown files in any text editor. For more, read [Daring Fireball's Markdown Syntax page](https://daringfireball.net/projects/markdown/syntax). -[]() - -### Working with Images and Graphics +## Working with Images and Graphics -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. +Image files in .gif or .png format are in the `docs/images` directory in the Apache 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. +Most of the Apache 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. The Wikipedia page [Comparison of Vector Graphics Editors](http://en.wikipedia.org/wiki/Comparison_of_vector_graphics_editors) provides a list and comparison of commercial and free vector graphics editors. Note, however, that not all of these programs support the SVG format. -[]() - ## Writing Guidelines -The most important advice we can provide for working with the Project Geode docs is to spend some time becoming familiar with the existing source files and the structure of the project directory. In particular, note the following conventions and tips: +The most important advice we can provide for working with the Apache Geode docs is to spend some time becoming familiar with the existing source files and the structure of the project directory. In particular, note the following conventions and tips: - Top-level subdirectories organize topics into "books": basic_config, configuring, developing, etc. http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/131e99ee/geode-docs/README.md ---------------------------------------------------------------------- diff --git a/geode-docs/README.md b/geode-docs/README.md index 9f83260..9fb5870 100644 --- a/geode-docs/README.md +++ b/geode-docs/README.md @@ -1,4 +1,4 @@ -# Project Geode End-User Documentation +# Apache Geode End-User Documentation Apache Geode provides the full source for end-user documentation in markdown format. The latest check-ins to `incubator-geode/geode-docs` are regularly built and published to http://geode.incubator.apache.org/docs/. Users can build the markdown into an HTML user guide using [Bookbinder](https://github.com/pivotal-cf/bookbinder) and the instructions below.
