geode-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Anthony Baker (JIRA)" <j...@apache.org>
Subject [jira] [Created] (GEODE-1952) Merge documentation to develop branch
Date Fri, 30 Sep 2016 01:24:20 GMT
Anthony Baker created GEODE-1952:
------------------------------------

             Summary: Merge documentation to develop branch
                 Key: GEODE-1952
                 URL: https://issues.apache.org/jira/browse/GEODE-1952
             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 geode.apache.org.

[1] https://git-wip-us.apache.org/repos/asf?p=incubator-geode.git;a=tree;h=refs/heads/staging/docs-grant1;hb=refs/heads/staging/docs-grant1

[2] http://geode.docs.pivotal.io




--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message