Donation of Geode Docs [was: Re: What will it take to release geode 1.0?]

[Niall Pemberton <ni...@gmail.com>]

On Fri, Apr 29, 2016 at 10:28 PM, Dave Barnes <db...@pivotal.io> wrote:

> We plan at some point to donate the docs so they'll be incorporated into
> the repo. Is this a prerequisite to graduating from incubation?
>

What is the status of the docs being donated? I raise this because the
Cassandra project was recently given a hard time by a board member about
docs hosted on a vendor site[1].

[1] http://markmail.org/message/uqsizgjxi7lwjcv7

Niall

Re: Donation of Geode Docs [was: Re: What will it take to release geode 1.0?]

[Joey McAllister <jm...@pivotal.io>]

Ok, great. Thanks, Jens!
On Mon, Jun 27, 2016 at 8:30 AM Jens Deppe <jd...@pivotal.io> wrote:

> Joey,
>
> We can configure CI to ignore changes to doc files so that they won't
> trigger a build; so that shouldn't be a concern here.
>
> --Jens
>
> On Fri, Jun 24, 2016 at 5:51 PM, Joey McAllister <jm...@pivotal.io>
> wrote:
>
> > Hi all,
> >
> > Pivotal currently is working through the process of converting the
> existing
> > Geode manual from DITA to the more open-source-friendly markdown. The
> value
> > in this is that anyone will be able to contribute, rather than just folks
> > who have access to DITA editors.
> >
> > Our automated conversion introduced some bugs that we're manually
> cleaning
> > up now. Once that's done, we'll be ready to move the manual into an
> Apache
> > repo and host it on the website.
> >
> > Regarding the repo: Do Apache projects usually use the same repo for code
> > and for documentation, or do they separate them so that adding to or
> > editing the docs doesn't necessitate kicking off an application build?
> >
> > Best,
> > Joey
> >
> > On Thu, Jun 23, 2016 at 9:20 AM Nitin Lamba <nl...@apache.org> wrote:
> >
> > > From a technology readiness perspective, hosting the docs on a
> different
> > > (Apache) site should not be too hard; I've built the docs locally and
> on
> > > AWS without any major issues.
> > >
> > > Irrespective of the hosting location, the content license needs to be
> > fixed
> > > - as per the current github repo [1], it still has Pivotal copyright
> > though
> > > the generated pages (ruby/ markdown to HTML) has ASF copyright in the
> > > footer.
> > >
> > > Nitin
> > > [1] https://github.com/project-geode/docs
> > >
> > >
> > > On Wed, Jun 22, 2016 at 6:10 PM, Gregory Chase <gc...@pivotal.io>
> > wrote:
> > >
> > > > This is an interesting topic.
> > > >
> > > > I've noted Planet Cassandra has free high quality vendor support on
> > > behalf
> > > > of the Apache Cassandra project.
> > > >
> > > > What is appropriate in terms of core content in the community versus
> > > > adjunct members of the community such as companies to create
> derivative
> > > > works?
> > > >
> > > > I could imagine the collaborative authoring of documentation might
> take
> > > > place on the wiki, for example. However companies interested in
> > creating
> > > > commercial derivatives might choose to take this content, do
> additional
> > > > editing, add proprietary value-added information, and lay it out in a
> > > more
> > > > visually pleasing manner.
> > > >
> > > > -Greg
> > > >
> > > > On Wed, Jun 22, 2016 at 5:54 PM, Niall Pemberton <
> > > > niall.pemberton@gmail.com>
> > > > wrote:
> > > >
> > > > > On Fri, Apr 29, 2016 at 10:28 PM, Dave Barnes <db...@pivotal.io>
> > > > wrote:
> > > > >
> > > > > > We plan at some point to donate the docs so they'll be
> incorporated
> > > > into
> > > > > > the repo. Is this a prerequisite to graduating from incubation?
> > > > > >
> > > > >
> > > > > What is the status of the docs being donated? I raise this because
> > the
> > > > > Cassandra project was recently given a hard time by a board member
> > > about
> > > > > docs hosted on a vendor site[1].
> > > > >
> > > > > [1] http://markmail.org/message/uqsizgjxi7lwjcv7
> > > > >
> > > > > Niall
> > > > >
> > > >
> > > >
> > > >
> > > > --
> > > > Greg Chase
> > > >
> > > > Global Head, Big Data Communities
> > > > http://www.pivotal.io/big-data
> > > >
> > > > Pivotal Software
> > > > http://www.pivotal.io/
> > > >
> > > > 650-215-0477
> > > > @GregChase
> > > > Blog: http://geekmarketing.biz/
> > > >
> > >
> >
>

Re: Donation of Geode Docs [was: Re: What will it take to release geode 1.0?]

[Jens Deppe <jd...@pivotal.io>]

Joey,

We can configure CI to ignore changes to doc files so that they won't
trigger a build; so that shouldn't be a concern here.

--Jens

On Fri, Jun 24, 2016 at 5:51 PM, Joey McAllister <jm...@pivotal.io>
wrote:

> Hi all,
>
> Pivotal currently is working through the process of converting the existing
> Geode manual from DITA to the more open-source-friendly markdown. The value
> in this is that anyone will be able to contribute, rather than just folks
> who have access to DITA editors.
>
> Our automated conversion introduced some bugs that we're manually cleaning
> up now. Once that's done, we'll be ready to move the manual into an Apache
> repo and host it on the website.
>
> Regarding the repo: Do Apache projects usually use the same repo for code
> and for documentation, or do they separate them so that adding to or
> editing the docs doesn't necessitate kicking off an application build?
>
> Best,
> Joey
>
> On Thu, Jun 23, 2016 at 9:20 AM Nitin Lamba <nl...@apache.org> wrote:
>
> > From a technology readiness perspective, hosting the docs on a different
> > (Apache) site should not be too hard; I've built the docs locally and on
> > AWS without any major issues.
> >
> > Irrespective of the hosting location, the content license needs to be
> fixed
> > - as per the current github repo [1], it still has Pivotal copyright
> though
> > the generated pages (ruby/ markdown to HTML) has ASF copyright in the
> > footer.
> >
> > Nitin
> > [1] https://github.com/project-geode/docs
> >
> >
> > On Wed, Jun 22, 2016 at 6:10 PM, Gregory Chase <gc...@pivotal.io>
> wrote:
> >
> > > This is an interesting topic.
> > >
> > > I've noted Planet Cassandra has free high quality vendor support on
> > behalf
> > > of the Apache Cassandra project.
> > >
> > > What is appropriate in terms of core content in the community versus
> > > adjunct members of the community such as companies to create derivative
> > > works?
> > >
> > > I could imagine the collaborative authoring of documentation might take
> > > place on the wiki, for example. However companies interested in
> creating
> > > commercial derivatives might choose to take this content, do additional
> > > editing, add proprietary value-added information, and lay it out in a
> > more
> > > visually pleasing manner.
> > >
> > > -Greg
> > >
> > > On Wed, Jun 22, 2016 at 5:54 PM, Niall Pemberton <
> > > niall.pemberton@gmail.com>
> > > wrote:
> > >
> > > > On Fri, Apr 29, 2016 at 10:28 PM, Dave Barnes <db...@pivotal.io>
> > > wrote:
> > > >
> > > > > We plan at some point to donate the docs so they'll be incorporated
> > > into
> > > > > the repo. Is this a prerequisite to graduating from incubation?
> > > > >
> > > >
> > > > What is the status of the docs being donated? I raise this because
> the
> > > > Cassandra project was recently given a hard time by a board member
> > about
> > > > docs hosted on a vendor site[1].
> > > >
> > > > [1] http://markmail.org/message/uqsizgjxi7lwjcv7
> > > >
> > > > Niall
> > > >
> > >
> > >
> > >
> > > --
> > > Greg Chase
> > >
> > > Global Head, Big Data Communities
> > > http://www.pivotal.io/big-data
> > >
> > > Pivotal Software
> > > http://www.pivotal.io/
> > >
> > > 650-215-0477
> > > @GregChase
> > > Blog: http://geekmarketing.biz/
> > >
> >
>

Re: Donation of Geode Docs [was: Re: What will it take to release geode 1.0?]

[Roman Shaposhnik <ro...@shaposhnik.org>]

On Fri, Jun 24, 2016 at 5:51 PM, Joey McAllister <jm...@pivotal.io> wrote:
> Regarding the repo: Do Apache projects usually use the same repo for code
> and for documentation, or do they separate them so that adding to or
> editing the docs doesn't necessitate kicking off an application build?

You can do it either way. Personally the only thing I feel strongly
about is that
docs should be part of the release artifacts for every Geode release. If they
are maintained in the same repo -- it simplifies release automation, but I think
either way can be accommodated.

Thanks,
Roman.

Re: Donation of Geode Docs [was: Re: What will it take to release geode 1.0?]

[Joey McAllister <jm...@pivotal.io>]

Hi all,

Pivotal currently is working through the process of converting the existing
Geode manual from DITA to the more open-source-friendly markdown. The value
in this is that anyone will be able to contribute, rather than just folks
who have access to DITA editors.

Our automated conversion introduced some bugs that we're manually cleaning
up now. Once that's done, we'll be ready to move the manual into an Apache
repo and host it on the website.

Regarding the repo: Do Apache projects usually use the same repo for code
and for documentation, or do they separate them so that adding to or
editing the docs doesn't necessitate kicking off an application build?

Best,
Joey

On Thu, Jun 23, 2016 at 9:20 AM Nitin Lamba <nl...@apache.org> wrote:

> From a technology readiness perspective, hosting the docs on a different
> (Apache) site should not be too hard; I've built the docs locally and on
> AWS without any major issues.
>
> Irrespective of the hosting location, the content license needs to be fixed
> - as per the current github repo [1], it still has Pivotal copyright though
> the generated pages (ruby/ markdown to HTML) has ASF copyright in the
> footer.
>
> Nitin
> [1] https://github.com/project-geode/docs
>
>
> On Wed, Jun 22, 2016 at 6:10 PM, Gregory Chase <gc...@pivotal.io> wrote:
>
> > This is an interesting topic.
> >
> > I've noted Planet Cassandra has free high quality vendor support on
> behalf
> > of the Apache Cassandra project.
> >
> > What is appropriate in terms of core content in the community versus
> > adjunct members of the community such as companies to create derivative
> > works?
> >
> > I could imagine the collaborative authoring of documentation might take
> > place on the wiki, for example. However companies interested in creating
> > commercial derivatives might choose to take this content, do additional
> > editing, add proprietary value-added information, and lay it out in a
> more
> > visually pleasing manner.
> >
> > -Greg
> >
> > On Wed, Jun 22, 2016 at 5:54 PM, Niall Pemberton <
> > niall.pemberton@gmail.com>
> > wrote:
> >
> > > On Fri, Apr 29, 2016 at 10:28 PM, Dave Barnes <db...@pivotal.io>
> > wrote:
> > >
> > > > We plan at some point to donate the docs so they'll be incorporated
> > into
> > > > the repo. Is this a prerequisite to graduating from incubation?
> > > >
> > >
> > > What is the status of the docs being donated? I raise this because the
> > > Cassandra project was recently given a hard time by a board member
> about
> > > docs hosted on a vendor site[1].
> > >
> > > [1] http://markmail.org/message/uqsizgjxi7lwjcv7
> > >
> > > Niall
> > >
> >
> >
> >
> > --
> > Greg Chase
> >
> > Global Head, Big Data Communities
> > http://www.pivotal.io/big-data
> >
> > Pivotal Software
> > http://www.pivotal.io/
> >
> > 650-215-0477
> > @GregChase
> > Blog: http://geekmarketing.biz/
> >
>

Re: Donation of Geode Docs [was: Re: What will it take to release geode 1.0?]

[Nitin Lamba <nl...@apache.org>]

From a technology readiness perspective, hosting the docs on a different
(Apache) site should not be too hard; I've built the docs locally and on
AWS without any major issues.

Irrespective of the hosting location, the content license needs to be fixed
- as per the current github repo [1], it still has Pivotal copyright though
the generated pages (ruby/ markdown to HTML) has ASF copyright in the
footer.

Nitin
[1] https://github.com/project-geode/docs


On Wed, Jun 22, 2016 at 6:10 PM, Gregory Chase <gc...@pivotal.io> wrote:

> This is an interesting topic.
>
> I've noted Planet Cassandra has free high quality vendor support on behalf
> of the Apache Cassandra project.
>
> What is appropriate in terms of core content in the community versus
> adjunct members of the community such as companies to create derivative
> works?
>
> I could imagine the collaborative authoring of documentation might take
> place on the wiki, for example. However companies interested in creating
> commercial derivatives might choose to take this content, do additional
> editing, add proprietary value-added information, and lay it out in a more
> visually pleasing manner.
>
> -Greg
>
> On Wed, Jun 22, 2016 at 5:54 PM, Niall Pemberton <
> niall.pemberton@gmail.com>
> wrote:
>
> > On Fri, Apr 29, 2016 at 10:28 PM, Dave Barnes <db...@pivotal.io>
> wrote:
> >
> > > We plan at some point to donate the docs so they'll be incorporated
> into
> > > the repo. Is this a prerequisite to graduating from incubation?
> > >
> >
> > What is the status of the docs being donated? I raise this because the
> > Cassandra project was recently given a hard time by a board member about
> > docs hosted on a vendor site[1].
> >
> > [1] http://markmail.org/message/uqsizgjxi7lwjcv7
> >
> > Niall
> >
>
>
>
> --
> Greg Chase
>
> Global Head, Big Data Communities
> http://www.pivotal.io/big-data
>
> Pivotal Software
> http://www.pivotal.io/
>
> 650-215-0477
> @GregChase
> Blog: http://geekmarketing.biz/
>

Re: Donation of Geode Docs [was: Re: What will it take to release geode 1.0?]

[Gregory Chase <gc...@pivotal.io>]

This is an interesting topic.

I've noted Planet Cassandra has free high quality vendor support on behalf
of the Apache Cassandra project.

What is appropriate in terms of core content in the community versus
adjunct members of the community such as companies to create derivative
works?

I could imagine the collaborative authoring of documentation might take
place on the wiki, for example. However companies interested in creating
commercial derivatives might choose to take this content, do additional
editing, add proprietary value-added information, and lay it out in a more
visually pleasing manner.

-Greg

On Wed, Jun 22, 2016 at 5:54 PM, Niall Pemberton <ni...@gmail.com>
wrote:

> On Fri, Apr 29, 2016 at 10:28 PM, Dave Barnes <db...@pivotal.io> wrote:
>
> > We plan at some point to donate the docs so they'll be incorporated into
> > the repo. Is this a prerequisite to graduating from incubation?
> >
>
> What is the status of the docs being donated? I raise this because the
> Cassandra project was recently given a hard time by a board member about
> docs hosted on a vendor site[1].
>
> [1] http://markmail.org/message/uqsizgjxi7lwjcv7
>
> Niall
>



-- 
Greg Chase

Global Head, Big Data Communities
http://www.pivotal.io/big-data

Pivotal Software
http://www.pivotal.io/

650-215-0477
@GregChase
Blog: http://geekmarketing.biz/