Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 4.47 KB

CONTRIBUTE.md

File metadata and controls

94 lines (61 loc) · 4.47 KB
Raw

Contributing to the Apache Geode Documentation

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:

For instructions on building the documentation locally, see ../geode-book/README.md.

Working with Markdown Files

You can edit markdown files in any text editor. For more, read Daring Fireball's Markdown Syntax page.

Working with Images and Graphics

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 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 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 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.
  • Use lowercase characters for all file and directory names. Separate words in filenames with an underscore (_) character.
  • Use the .md file extension for topic files.
  • Add new topics to the existing directories by subject type. Only create a new directory if you are starting a new subject or a new book.
  • To start a new topic, you can make a copy of an existing file with similar content and edit it.
  • Use the appropriate document type for the content you are writing. Create multiple topics if you are writing overview, procedural, and reference content.
  • To edit elements in the navigation pane (the "subnav") that appears on the left side of the documentation, navigate to ../geode-book/master_middleman/source/subnavs/geode-subnav.md.

Product Name Variables

For flexibility, the product name (a long version and a short one) and version are defined as variables. Here's how to use them:

Define these three variables in ../geode-book/config.yml:

template_variables:
  - product_name_long: Apache Geode
  - product_name: Geode
  - product_version: 1.2

Use the following Ruby syntax to refer to these variables everywhere except in title: lines:

<%=vars.product_name %>
<%=vars.product_name_long %>
<%=vars.product_version %>

You can't use these variables in title: lines. Here's the workaround:

Instead of:

---
title: Apache Geode 1.2 Documentation
---

Do this:

<% set_title(product_name_long, product_version, "Documentation") %>

Why? Because the title: construct is not Ruby code, it's YAML, and it cannot interpret Ruby variables.

Cautions:

  • Begin with <%, not <%=. (We're invoking a function, not printing its value.)
  • Do not put a space before the opening parenthesis (use set_title( not set_title (.)
  • Do not quote the three product variable names (product_name, product_name_long, and product_version). Do quote all other text.
  • This feature requires Bookbinder v10.1.7 (Aug 2017) or later.