You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geode.apache.org by Dave Barnes <db...@pivotal.io> on 2018/01/29 18:39:27 UTC

Geode Website Docs page: Proposal to limit the number of versions listed.

Question:
How many versions of the User Documentation and the Javadocs do we need to
see on the Geode Docs page (http://geode.apache.org/docs)?

The current scheme has two policies:
- For the User Documentation, there's a link for each of four versions:
1.0, 1.1, 1.2 and 1.3. There will soon be a fifth bullet for v1.4.
- For the Javadocs, there's only one link which points to the latest
version, currently 1.3. Users who need earlier versions can presumably find
them among their own copies of the source code.

Proposal:
- Shorten the list for the User Documentation, showing only the three most
recent versions
- No change for the Javadocs, link to only the most recent version

What do you think?

Re: Geode Website Docs page: Proposal to limit the number of versions listed.

Posted by Dave Barnes <db...@pivotal.io>.
Based on comments received, no changes for Geode 1.4.

On Wed, Jan 31, 2018 at 11:05 AM, Sai Boorlagadda <sai.boorlagadda@gmail.com
> wrote:

> Adding user@geode.apache.org to the email thread to see if any users has
> inputs.
> I'm fine showing only one version of Java docs, as a developer I access
> the Java docs in my IDE based on which ever version I am using to build
> geode application.
>
> Sai
>
> On Wed, Jan 31, 2018 at 10:23 AM, Dave Barnes <db...@pivotal.io> wrote:
>
>> I'm hearing that access to earlier versions of the User Guide is important
>> to some folks.
>> Everyone OK with only one version of the Javadocs, as is the current
>> practice?
>>
>>
>> On Mon, Jan 29, 2018 at 11:12 AM, Alexander Murmann <am...@pivotal.io>
>> wrote:
>>
>> > Maybe we could have a link at the bottom that goes to a full list?
>> >
>> > On Mon, Jan 29, 2018 at 11:10 AM, Michael William Dodge <
>> mdodge@pivotal.io
>> > >
>> > wrote:
>> >
>> > > I'm fine with the proposal. It would be nice if there was a way to
>> > > navigate to user documentation for older versions; perhaps just rely
>> on
>> > > Google? ;)
>> > >
>> > > Sarge
>> > >
>> > > > On 29 Jan, 2018, at 10:39, Dave Barnes <db...@pivotal.io> wrote:
>> > > >
>> > > > Question:
>> > > > How many versions of the User Documentation and the Javadocs do we
>> need
>> > > to
>> > > > see on the Geode Docs page (http://geode.apache.org/docs)?
>> > > >
>> > > > The current scheme has two policies:
>> > > > - For the User Documentation, there's a link for each of four
>> versions:
>> > > > 1.0, 1.1, 1.2 and 1.3. There will soon be a fifth bullet for v1.4.
>> > > > - For the Javadocs, there's only one link which points to the latest
>> > > > version, currently 1.3. Users who need earlier versions can
>> presumably
>> > > find
>> > > > them among their own copies of the source code.
>> > > >
>> > > > Proposal:
>> > > > - Shorten the list for the User Documentation, showing only the
>> three
>> > > most
>> > > > recent versions
>> > > > - No change for the Javadocs, link to only the most recent version
>> > > >
>> > > > What do you think?
>> > >
>> > >
>> >
>>
>
>

Re: Geode Website Docs page: Proposal to limit the number of versions listed.

Posted by Dave Barnes <db...@pivotal.io>.
Based on comments received, no changes for Geode 1.4.

On Wed, Jan 31, 2018 at 11:05 AM, Sai Boorlagadda <sai.boorlagadda@gmail.com
> wrote:

> Adding user@geode.apache.org to the email thread to see if any users has
> inputs.
> I'm fine showing only one version of Java docs, as a developer I access
> the Java docs in my IDE based on which ever version I am using to build
> geode application.
>
> Sai
>
> On Wed, Jan 31, 2018 at 10:23 AM, Dave Barnes <db...@pivotal.io> wrote:
>
>> I'm hearing that access to earlier versions of the User Guide is important
>> to some folks.
>> Everyone OK with only one version of the Javadocs, as is the current
>> practice?
>>
>>
>> On Mon, Jan 29, 2018 at 11:12 AM, Alexander Murmann <am...@pivotal.io>
>> wrote:
>>
>> > Maybe we could have a link at the bottom that goes to a full list?
>> >
>> > On Mon, Jan 29, 2018 at 11:10 AM, Michael William Dodge <
>> mdodge@pivotal.io
>> > >
>> > wrote:
>> >
>> > > I'm fine with the proposal. It would be nice if there was a way to
>> > > navigate to user documentation for older versions; perhaps just rely
>> on
>> > > Google? ;)
>> > >
>> > > Sarge
>> > >
>> > > > On 29 Jan, 2018, at 10:39, Dave Barnes <db...@pivotal.io> wrote:
>> > > >
>> > > > Question:
>> > > > How many versions of the User Documentation and the Javadocs do we
>> need
>> > > to
>> > > > see on the Geode Docs page (http://geode.apache.org/docs)?
>> > > >
>> > > > The current scheme has two policies:
>> > > > - For the User Documentation, there's a link for each of four
>> versions:
>> > > > 1.0, 1.1, 1.2 and 1.3. There will soon be a fifth bullet for v1.4.
>> > > > - For the Javadocs, there's only one link which points to the latest
>> > > > version, currently 1.3. Users who need earlier versions can
>> presumably
>> > > find
>> > > > them among their own copies of the source code.
>> > > >
>> > > > Proposal:
>> > > > - Shorten the list for the User Documentation, showing only the
>> three
>> > > most
>> > > > recent versions
>> > > > - No change for the Javadocs, link to only the most recent version
>> > > >
>> > > > What do you think?
>> > >
>> > >
>> >
>>
>
>

Re: Geode Website Docs page: Proposal to limit the number of versions listed.

Posted by Sai Boorlagadda <sa...@gmail.com>.
Adding user@geode.apache.org to the email thread to see if any users has
inputs.
I'm fine showing only one version of Java docs, as a developer I access the
Java docs in my IDE based on which ever version I am using to build geode
application.

Sai

On Wed, Jan 31, 2018 at 10:23 AM, Dave Barnes <db...@pivotal.io> wrote:

> I'm hearing that access to earlier versions of the User Guide is important
> to some folks.
> Everyone OK with only one version of the Javadocs, as is the current
> practice?
>
>
> On Mon, Jan 29, 2018 at 11:12 AM, Alexander Murmann <am...@pivotal.io>
> wrote:
>
> > Maybe we could have a link at the bottom that goes to a full list?
> >
> > On Mon, Jan 29, 2018 at 11:10 AM, Michael William Dodge <
> mdodge@pivotal.io
> > >
> > wrote:
> >
> > > I'm fine with the proposal. It would be nice if there was a way to
> > > navigate to user documentation for older versions; perhaps just rely on
> > > Google? ;)
> > >
> > > Sarge
> > >
> > > > On 29 Jan, 2018, at 10:39, Dave Barnes <db...@pivotal.io> wrote:
> > > >
> > > > Question:
> > > > How many versions of the User Documentation and the Javadocs do we
> need
> > > to
> > > > see on the Geode Docs page (http://geode.apache.org/docs)?
> > > >
> > > > The current scheme has two policies:
> > > > - For the User Documentation, there's a link for each of four
> versions:
> > > > 1.0, 1.1, 1.2 and 1.3. There will soon be a fifth bullet for v1.4.
> > > > - For the Javadocs, there's only one link which points to the latest
> > > > version, currently 1.3. Users who need earlier versions can
> presumably
> > > find
> > > > them among their own copies of the source code.
> > > >
> > > > Proposal:
> > > > - Shorten the list for the User Documentation, showing only the three
> > > most
> > > > recent versions
> > > > - No change for the Javadocs, link to only the most recent version
> > > >
> > > > What do you think?
> > >
> > >
> >
>

Re: Geode Website Docs page: Proposal to limit the number of versions listed.

Posted by Sai Boorlagadda <sa...@gmail.com>.
Adding user@geode.apache.org to the email thread to see if any users has
inputs.
I'm fine showing only one version of Java docs, as a developer I access the
Java docs in my IDE based on which ever version I am using to build geode
application.

Sai

On Wed, Jan 31, 2018 at 10:23 AM, Dave Barnes <db...@pivotal.io> wrote:

> I'm hearing that access to earlier versions of the User Guide is important
> to some folks.
> Everyone OK with only one version of the Javadocs, as is the current
> practice?
>
>
> On Mon, Jan 29, 2018 at 11:12 AM, Alexander Murmann <am...@pivotal.io>
> wrote:
>
> > Maybe we could have a link at the bottom that goes to a full list?
> >
> > On Mon, Jan 29, 2018 at 11:10 AM, Michael William Dodge <
> mdodge@pivotal.io
> > >
> > wrote:
> >
> > > I'm fine with the proposal. It would be nice if there was a way to
> > > navigate to user documentation for older versions; perhaps just rely on
> > > Google? ;)
> > >
> > > Sarge
> > >
> > > > On 29 Jan, 2018, at 10:39, Dave Barnes <db...@pivotal.io> wrote:
> > > >
> > > > Question:
> > > > How many versions of the User Documentation and the Javadocs do we
> need
> > > to
> > > > see on the Geode Docs page (http://geode.apache.org/docs)?
> > > >
> > > > The current scheme has two policies:
> > > > - For the User Documentation, there's a link for each of four
> versions:
> > > > 1.0, 1.1, 1.2 and 1.3. There will soon be a fifth bullet for v1.4.
> > > > - For the Javadocs, there's only one link which points to the latest
> > > > version, currently 1.3. Users who need earlier versions can
> presumably
> > > find
> > > > them among their own copies of the source code.
> > > >
> > > > Proposal:
> > > > - Shorten the list for the User Documentation, showing only the three
> > > most
> > > > recent versions
> > > > - No change for the Javadocs, link to only the most recent version
> > > >
> > > > What do you think?
> > >
> > >
> >
>

Re: Geode Website Docs page: Proposal to limit the number of versions listed.

Posted by Dave Barnes <db...@pivotal.io>.
I'm hearing that access to earlier versions of the User Guide is important
to some folks.
Everyone OK with only one version of the Javadocs, as is the current
practice?


On Mon, Jan 29, 2018 at 11:12 AM, Alexander Murmann <am...@pivotal.io>
wrote:

> Maybe we could have a link at the bottom that goes to a full list?
>
> On Mon, Jan 29, 2018 at 11:10 AM, Michael William Dodge <mdodge@pivotal.io
> >
> wrote:
>
> > I'm fine with the proposal. It would be nice if there was a way to
> > navigate to user documentation for older versions; perhaps just rely on
> > Google? ;)
> >
> > Sarge
> >
> > > On 29 Jan, 2018, at 10:39, Dave Barnes <db...@pivotal.io> wrote:
> > >
> > > Question:
> > > How many versions of the User Documentation and the Javadocs do we need
> > to
> > > see on the Geode Docs page (http://geode.apache.org/docs)?
> > >
> > > The current scheme has two policies:
> > > - For the User Documentation, there's a link for each of four versions:
> > > 1.0, 1.1, 1.2 and 1.3. There will soon be a fifth bullet for v1.4.
> > > - For the Javadocs, there's only one link which points to the latest
> > > version, currently 1.3. Users who need earlier versions can presumably
> > find
> > > them among their own copies of the source code.
> > >
> > > Proposal:
> > > - Shorten the list for the User Documentation, showing only the three
> > most
> > > recent versions
> > > - No change for the Javadocs, link to only the most recent version
> > >
> > > What do you think?
> >
> >
>

Re: Geode Website Docs page: Proposal to limit the number of versions listed.

Posted by Alexander Murmann <am...@pivotal.io>.
Maybe we could have a link at the bottom that goes to a full list?

On Mon, Jan 29, 2018 at 11:10 AM, Michael William Dodge <md...@pivotal.io>
wrote:

> I'm fine with the proposal. It would be nice if there was a way to
> navigate to user documentation for older versions; perhaps just rely on
> Google? ;)
>
> Sarge
>
> > On 29 Jan, 2018, at 10:39, Dave Barnes <db...@pivotal.io> wrote:
> >
> > Question:
> > How many versions of the User Documentation and the Javadocs do we need
> to
> > see on the Geode Docs page (http://geode.apache.org/docs)?
> >
> > The current scheme has two policies:
> > - For the User Documentation, there's a link for each of four versions:
> > 1.0, 1.1, 1.2 and 1.3. There will soon be a fifth bullet for v1.4.
> > - For the Javadocs, there's only one link which points to the latest
> > version, currently 1.3. Users who need earlier versions can presumably
> find
> > them among their own copies of the source code.
> >
> > Proposal:
> > - Shorten the list for the User Documentation, showing only the three
> most
> > recent versions
> > - No change for the Javadocs, link to only the most recent version
> >
> > What do you think?
>
>

Re: Geode Website Docs page: Proposal to limit the number of versions listed.

Posted by Michael William Dodge <md...@pivotal.io>.
I'm fine with the proposal. It would be nice if there was a way to navigate to user documentation for older versions; perhaps just rely on Google? ;)

Sarge

> On 29 Jan, 2018, at 10:39, Dave Barnes <db...@pivotal.io> wrote:
> 
> Question:
> How many versions of the User Documentation and the Javadocs do we need to
> see on the Geode Docs page (http://geode.apache.org/docs)?
> 
> The current scheme has two policies:
> - For the User Documentation, there's a link for each of four versions:
> 1.0, 1.1, 1.2 and 1.3. There will soon be a fifth bullet for v1.4.
> - For the Javadocs, there's only one link which points to the latest
> version, currently 1.3. Users who need earlier versions can presumably find
> them among their own copies of the source code.
> 
> Proposal:
> - Shorten the list for the User Documentation, showing only the three most
> recent versions
> - No change for the Javadocs, link to only the most recent version
> 
> What do you think?