geode-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dave Barnes (JIRA)" <>
Subject [jira] [Commented] (GEODE-1952) Merge documentation to develop branch
Date Tue, 04 Oct 2016 18:02:22 GMT


Dave Barnes commented on GEODE-1952:

I was advised by Roman NOT to check in changes to the staging branch.
Created feature/GEODE-1952 to track changes to the docs to prepare them for their contribution
to the repo.
First change: Consolidated all docs under a single 'geode-docs' directory.

> Merge documentation to develop branch
> -------------------------------------
>                 Key: GEODE-1952
>                 URL:
>             Project: Geode
>          Issue Type: New Feature
>          Components: docs
>            Reporter: Anthony Baker
> The staging/docs-grant1 branch [1] contains the source current used to build the documentation
site [2] for geode.  In order to merge this source init the develop branch, we need to:
> 1) Review the files and determine if there are any licensing or dependency considerations.
 Update the LICENSE and NOTICE files as necessary.
> 2) Update the source headers and replace with the Apache source header as needed.  Since
these are documentation files, determine if a source header is required.
> 3) Improve the build process to make it simpler for contributors and users. This includes
writing up build instructions.  We will need to create a top-level directory (geode-docs?)
to hold the files.
> 4) Include the documentation in the source distributions created by the build.
> 5) Incorporate other suggestions from the community.
> Once the branch has been merged, we should host the documentation site on
> [1];a=tree;h=refs/heads/staging/docs-grant1;hb=refs/heads/staging/docs-grant1
> [2]

This message was sent by Atlassian JIRA

View raw message