Javadoc version

[Ken Krugler]

Perusing the docs, and noticed this... 

https://ci.apache.org/projects/flink/flink-docs-release-1.0/api/java/ says "flink 1.0-SNAPSHOT API"

I assume this shouldn't be called the snapshot version.

-- Ken

--------------------------

Ken Krugler

[phone]

http://www.scaleunlimited.com

custom big data solutions & training

Hadoop, Cascading, Cassandra & Solr

[rmetzger0]

Hi Ken,

we are building the docs for each version based on the "release-x.y" branch. This branch contains the snapshot version of the respective version.

This allows us to fix documentation issues without releasing a new version. But you are right, it may happen that the docs / javadocs are slightly out of sync, but usually we only merge fixes to the "release-x.y." branches, so there should never be inconsistencies, just fixes.

On Tue, Mar 15, 2016 at 5:34 PM, Ken Krugler <[hidden email]> wrote:

Perusing the docs, and noticed this... 

https://ci.apache.org/projects/flink/flink-docs-release-1.0/api/java/ says "flink 1.0-SNAPSHOT API"

I assume this shouldn't be called the snapshot version.

-- Ken

--------------------------

Ken Krugler

<a href="tel:%2B1%20530-210-6378" value="[phone]" target="_blank">[phone]

http://www.scaleunlimited.com

custom big data solutions & training

Hadoop, Cascading, Cassandra & Solr

[Ken Krugler]

Hi Robert,

Thanks for the explanation.

Though "1.0-SNAPSHOT" is the default version for many projects throughout their lifespan :)

So I think it's a bit confusing. That's the main issue for me, not whether the docs are slightly out of sync with the actual 1.0 release code.

In any case, it's a minor issue. I thought originally someone just forgot to update the version during the doc release process.

Regards,

-- Ken

---

From: Robert Metzger

Sent: March 18, 2016 2:07:26am PDT

To: [hidden email]

Subject: Re: Javadoc version

Hi Ken,

we are building the docs for each version based on the "release-x.y" branch. This branch contains the snapshot version of the respective version.

This allows us to fix documentation issues without releasing a new version. But you are right, it may happen that the docs / javadocs are slightly out of sync, but usually we only merge fixes to the "release-x.y." branches, so there should never be inconsistencies, just fixes.

On Tue, Mar 15, 2016 at 5:34 PM, Ken Krugler <[hidden email]> wrote:

Perusing the docs, and noticed this... 

https://ci.apache.org/projects/flink/flink-docs-release-1.0/api/java/ says "flink 1.0-SNAPSHOT API"

I assume this shouldn't be called the snapshot version.

-- Ken

--------------------------

Ken Krugler

[phone]

http://www.scaleunlimited.com

custom big data solutions & training

Hadoop, Cascading, Cassandra & Solr

[rmetzger0]

Hi Ken,

I see, 1.0-SNAPSHOT in particular is a bad version because that's the default version from the maven archetypes. 

Lets see, if more users stumble across this, we can see if there is an easy fix.

Also, in (hopefully) ~3 months we'll have Flink 1.1 and then it won't look that bad anymore.

Regards,

Robert

On Fri, Mar 18, 2016 at 6:27 PM, Ken Krugler <[hidden email]> wrote:

Hi Robert,

Thanks for the explanation.

Though "1.0-SNAPSHOT" is the default version for many projects throughout their lifespan :)

So I think it's a bit confusing. That's the main issue for me, not whether the docs are slightly out of sync with the actual 1.0 release code.

In any case, it's a minor issue. I thought originally someone just forgot to update the version during the doc release process.

Regards,

-- Ken

---

From: Robert Metzger

Sent: March 18, 2016 2:07:26am PDT

To: [hidden email]

Subject: Re: Javadoc version

Hi Ken,

we are building the docs for each version based on the "release-x.y" branch. This branch contains the snapshot version of the respective version.

This allows us to fix documentation issues without releasing a new version. But you are right, it may happen that the docs / javadocs are slightly out of sync, but usually we only merge fixes to the "release-x.y." branches, so there should never be inconsistencies, just fixes.

On Tue, Mar 15, 2016 at 5:34 PM, Ken Krugler <[hidden email]> wrote:

Perusing the docs, and noticed this... 

https://ci.apache.org/projects/flink/flink-docs-release-1.0/api/java/ says "flink 1.0-SNAPSHOT API"

I assume this shouldn't be called the snapshot version.

-- Ken

--------------------------

Ken Krugler

<a href="tel:%2B1%20530-210-6378" value="[phone]" target="_blank">[phone]

http://www.scaleunlimited.com

custom big data solutions & training

Hadoop, Cascading, Cassandra & Solr