You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@geode.apache.org by "Dan Smith (JIRA)" <ji...@apache.org> on 2016/09/30 18:58:20 UTC

[jira] [Commented] (GEODE-1952) Merge documentation to develop branch

    [ https://issues.apache.org/jira/browse/GEODE-1952?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15536746#comment-15536746 ] 

Dan Smith commented on GEODE-1952:
----------------------------------

Regarding whether the files need headers, this link seems to suggest that they are needed - http://www.apache.org/legal/src-headers.html

{noformat}
Does this policy apply to documentation files included in a release?

Yes.
{noformat}

> 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)