1.2-SNAPSHOT documentation

classic Classic list List threaded Threaded
6 messages Options
Reply | Threaded
Open this post in threaded view
|

1.2-SNAPSHOT documentation

Ken Krugler
Hi all,

Quick question - how quickly are the online Javadocs updated to match snapshot builds?

E.g. https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html <https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html>

says it’s the 1.2-SNAPSHOT documentation, but it doesn’t match the current 1.2-SNAPSHOT jars that I’m downloading.

In particular, the RichTimelyFlatMapFunction is still in the documentation, but not the ProcessFunction.

So should I be using a different link for snapshot Javadocs?

Thanks,

— Ken

--------------------------
Ken Krugler
+1 530-210-6378
http://www.scaleunlimited.com
custom big data solutions & training
Hadoop, Cascading, Cassandra & Solr



Reply | Threaded
Open this post in threaded view
|

Re: 1.2-SNAPSHOT documentation

Timo Walther-2
Hi Ken,

the docs on the website need to be built manually at the moment. So they
might be out of sync.
If you want the most recent documentation you can checkout the git
repository and built the docs:

git clone https://github.com/apache/flink.git
./flink/docs/build_docs.sh

Regards,
Timo


Am 04/12/16 um 02:42 schrieb Ken Krugler:

> Hi all,
>
> Quick question - how quickly are the online Javadocs updated to match snapshot builds?
>
> E.g. https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html <https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html>
>
> says it’s the 1.2-SNAPSHOT documentation, but it doesn’t match the current 1.2-SNAPSHOT jars that I’m downloading.
>
> In particular, the RichTimelyFlatMapFunction is still in the documentation, but not the ProcessFunction.
>
> So should I be using a different link for snapshot Javadocs?
>
> Thanks,
>
> — Ken
>
> --------------------------
> Ken Krugler
> +1 530-210-6378
> http://www.scaleunlimited.com
> custom big data solutions & training
> Hadoop, Cascading, Cassandra & Solr
>
>
>
>


--
Freundliche Grüße / Kind Regards

Timo Walther

Follow me: @twalthr
https://www.linkedin.com/in/twalthr

mxm
Reply | Threaded
Open this post in threaded view
|

Re: 1.2-SNAPSHOT documentation

mxm
Hi Ken!

The docs are built nightly by the Apache Buildbot [1]. It seems like it is
failing lately. I'll look into it later.

Thanks,
max

[1] https://ci.apache.org/builders/flink-docs-master/

On Mon, Dec 5, 2016 at 8:28 AM, Timo Walther <[hidden email]> wrote:

> Hi Ken,
>
> the docs on the website need to be built manually at the moment. So they
> might be out of sync.
> If you want the most recent documentation you can checkout the git
> repository and built the docs:
>
> git clone https://github.com/apache/flink.git
> ./flink/docs/build_docs.sh
>
> Regards,
> Timo
>
>
> Am 04/12/16 um 02:42 schrieb Ken Krugler:
>
> Hi all,
>>
>> Quick question - how quickly are the online Javadocs updated to match
>> snapshot builds?
>>
>> E.g. https://ci.apache.org/projects/flink/flink-docs-master/api/
>> java/index.html?org/apache/flink/streaming/api/
>> datastream/KeyedStream.html <https://ci.apache.org/project
>> s/flink/flink-docs-master/api/java/index.html?org/apache/
>> flink/streaming/api/datastream/KeyedStream.html>
>>
>> says it’s the 1.2-SNAPSHOT documentation, but it doesn’t match the
>> current 1.2-SNAPSHOT jars that I’m downloading.
>>
>> In particular, the RichTimelyFlatMapFunction is still in the
>> documentation, but not the ProcessFunction.
>>
>> So should I be using a different link for snapshot Javadocs?
>>
>> Thanks,
>>
>> — Ken
>>
>> --------------------------
>> Ken Krugler
>> +1 530-210-6378
>> http://www.scaleunlimited.com
>> custom big data solutions & training
>> Hadoop, Cascading, Cassandra & Solr
>>
>>
>>
>>
>>
>
> --
> Freundliche Grüße / Kind Regards
>
> Timo Walther
>
> Follow me: @twalthr
> https://www.linkedin.com/in/twalthr
>
>
mxm
Reply | Threaded
Open this post in threaded view
|

Re: 1.2-SNAPSHOT documentation

mxm
The issue [1] has been resolved and I've rebuilt the snapshot version
of the docs. We're back to a nightly up-to-date documentation/JavaDoc.

[1] https://issues.apache.org/jira/browse/FLINK-5262

On Mon, Dec 5, 2016 at 11:47 AM, Maximilian Michels <[hidden email]> wrote:

> Hi Ken!
>
> The docs are built nightly by the Apache Buildbot [1]. It seems like it is
> failing lately. I'll look into it later.
>
> Thanks,
> max
>
> [1] https://ci.apache.org/builders/flink-docs-master/
>
> On Mon, Dec 5, 2016 at 8:28 AM, Timo Walther <[hidden email]> wrote:
>>
>> Hi Ken,
>>
>> the docs on the website need to be built manually at the moment. So they
>> might be out of sync.
>> If you want the most recent documentation you can checkout the git
>> repository and built the docs:
>>
>> git clone https://github.com/apache/flink.git
>> ./flink/docs/build_docs.sh
>>
>> Regards,
>> Timo
>>
>>
>> Am 04/12/16 um 02:42 schrieb Ken Krugler:
>>
>>> Hi all,
>>>
>>> Quick question - how quickly are the online Javadocs updated to match
>>> snapshot builds?
>>>
>>> E.g.
>>> https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html
>>> <https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html>
>>>
>>> says it’s the 1.2-SNAPSHOT documentation, but it doesn’t match the
>>> current 1.2-SNAPSHOT jars that I’m downloading.
>>>
>>> In particular, the RichTimelyFlatMapFunction is still in the
>>> documentation, but not the ProcessFunction.
>>>
>>> So should I be using a different link for snapshot Javadocs?
>>>
>>> Thanks,
>>>
>>> — Ken
>>>
>>> --------------------------
>>> Ken Krugler
>>> +1 530-210-6378
>>> http://www.scaleunlimited.com
>>> custom big data solutions & training
>>> Hadoop, Cascading, Cassandra & Solr
>>>
>>>
>>>
>>>
>>
>>
>> --
>> Freundliche Grüße / Kind Regards
>>
>> Timo Walther
>>
>> Follow me: @twalthr
>> https://www.linkedin.com/in/twalthr
>>
>
Reply | Threaded
Open this post in threaded view
|

Re: 1.2-SNAPSHOT documentation

Ken Krugler
Hi Max,

> On Dec 5, 2016, at 9:46am, Maximilian Michels <[hidden email]> wrote:
>
> The issue [1] has been resolved and I've rebuilt the snapshot version
> of the docs. We're back to a nightly up-to-date documentation/JavaDoc.
>
> [1] https://issues.apache.org/jira/browse/FLINK-5262

Thanks for looking into this!

Though if I look at https://ci.apache.org/builders/flink-docs-master/, it seems like the builds are still failing.

E.g. from #549 (https://ci.apache.org/builders/flink-docs-master/builds/549/steps/Flink%20docs/logs/stdio) I see:
> ERROR:  While executing gem ... (Errno::ENOENT)
>     No such file or directory - /home/gmcdonald/.gem/ruby/1.9.1/cache/bundler-1.13.6.gem
> /bin/sh: 13: bundle: not found
Also if I look at a page like https://ci.apache.org/projects/flink/flink-docs-master/api/java/org/apache/flink/streaming/api/datastream/KeyedStream.htm, it seems like there’s a CSS issue - or at least I’m getting layout problems with several different browsers.

Regards,

— Ken

>
> On Mon, Dec 5, 2016 at 11:47 AM, Maximilian Michels <[hidden email]> wrote:
>> Hi Ken!
>>
>> The docs are built nightly by the Apache Buildbot [1]. It seems like it is
>> failing lately. I'll look into it later.
>>
>> Thanks,
>> max
>>
>> [1] https://ci.apache.org/builders/flink-docs-master/
>>
>> On Mon, Dec 5, 2016 at 8:28 AM, Timo Walther <[hidden email]> wrote:
>>>
>>> Hi Ken,
>>>
>>> the docs on the website need to be built manually at the moment. So they
>>> might be out of sync.
>>> If you want the most recent documentation you can checkout the git
>>> repository and built the docs:
>>>
>>> git clone https://github.com/apache/flink.git
>>> ./flink/docs/build_docs.sh
>>>
>>> Regards,
>>> Timo
>>>
>>>
>>> Am 04/12/16 um 02:42 schrieb Ken Krugler:
>>>
>>>> Hi all,
>>>>
>>>> Quick question - how quickly are the online Javadocs updated to match
>>>> snapshot builds?
>>>>
>>>> E.g.
>>>> https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html
>>>> <https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html>
>>>>
>>>> says it’s the 1.2-SNAPSHOT documentation, but it doesn’t match the
>>>> current 1.2-SNAPSHOT jars that I’m downloading.
>>>>
>>>> In particular, the RichTimelyFlatMapFunction is still in the
>>>> documentation, but not the ProcessFunction.
>>>>
>>>> So should I be using a different link for snapshot Javadocs?
>>>>
>>>> Thanks,
>>>>
>>>> — Ken
>>>>
>>>> --------------------------
>>>> Ken Krugler
>>>> +1 530-210-6378
>>>> http://www.scaleunlimited.com
>>>> custom big data solutions & training
>>>> Hadoop, Cascading, Cassandra & Solr
>>>>
>>>>
>>>>
>>>>
>>>
>>>
>>> --
>>> Freundliche Grüße / Kind Regards
>>>
>>> Timo Walther
>>>
>>> Follow me: @twalthr
>>> https://www.linkedin.com/in/twalthr
>>>
>>

--------------------------
Ken Krugler
+1 530-210-6378
http://www.scaleunlimited.com
custom big data solutions & training
Hadoop, Cascading, Cassandra & Solr



mxm
Reply | Threaded
Open this post in threaded view
|

Re: 1.2-SNAPSHOT documentation

mxm
Hi Ken,

The first issue you reported is a corrupt Ruby configuration we can't
do much about.

The JavaDocs are not generated correctly because of malformed JavaDoc:
https://ci.apache.org/builders/flink-docs-master/builds/551/steps/Java%20%26%20Scala%20docs/logs/stdio
We will have to go through the affected classes and fix them.

Thanks,
Max

On Thu, Dec 8, 2016 at 5:09 AM, Ken Krugler <[hidden email]> wrote:

> Hi Max,
>
>> On Dec 5, 2016, at 9:46am, Maximilian Michels <[hidden email]> wrote:
>>
>> The issue [1] has been resolved and I've rebuilt the snapshot version
>> of the docs. We're back to a nightly up-to-date documentation/JavaDoc.
>>
>> [1] https://issues.apache.org/jira/browse/FLINK-5262
>
> Thanks for looking into this!
>
> Though if I look at https://ci.apache.org/builders/flink-docs-master/, it seems like the builds are still failing.
>
> E.g. from #549 (https://ci.apache.org/builders/flink-docs-master/builds/549/steps/Flink%20docs/logs/stdio) I see:
>> ERROR:  While executing gem ... (Errno::ENOENT)
>>     No such file or directory - /home/gmcdonald/.gem/ruby/1.9.1/cache/bundler-1.13.6.gem
>> /bin/sh: 13: bundle: not found
> Also if I look at a page like https://ci.apache.org/projects/flink/flink-docs-master/api/java/org/apache/flink/streaming/api/datastream/KeyedStream.htm, it seems like there’s a CSS issue - or at least I’m getting layout problems with several different browsers.
>
> Regards,
>
> — Ken
>
>>
>> On Mon, Dec 5, 2016 at 11:47 AM, Maximilian Michels <[hidden email]> wrote:
>>> Hi Ken!
>>>
>>> The docs are built nightly by the Apache Buildbot [1]. It seems like it is
>>> failing lately. I'll look into it later.
>>>
>>> Thanks,
>>> max
>>>
>>> [1] https://ci.apache.org/builders/flink-docs-master/
>>>
>>> On Mon, Dec 5, 2016 at 8:28 AM, Timo Walther <[hidden email]> wrote:
>>>>
>>>> Hi Ken,
>>>>
>>>> the docs on the website need to be built manually at the moment. So they
>>>> might be out of sync.
>>>> If you want the most recent documentation you can checkout the git
>>>> repository and built the docs:
>>>>
>>>> git clone https://github.com/apache/flink.git
>>>> ./flink/docs/build_docs.sh
>>>>
>>>> Regards,
>>>> Timo
>>>>
>>>>
>>>> Am 04/12/16 um 02:42 schrieb Ken Krugler:
>>>>
>>>>> Hi all,
>>>>>
>>>>> Quick question - how quickly are the online Javadocs updated to match
>>>>> snapshot builds?
>>>>>
>>>>> E.g.
>>>>> https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html
>>>>> <https://ci.apache.org/projects/flink/flink-docs-master/api/java/index.html?org/apache/flink/streaming/api/datastream/KeyedStream.html>
>>>>>
>>>>> says it’s the 1.2-SNAPSHOT documentation, but it doesn’t match the
>>>>> current 1.2-SNAPSHOT jars that I’m downloading.
>>>>>
>>>>> In particular, the RichTimelyFlatMapFunction is still in the
>>>>> documentation, but not the ProcessFunction.
>>>>>
>>>>> So should I be using a different link for snapshot Javadocs?
>>>>>
>>>>> Thanks,
>>>>>
>>>>> — Ken
>>>>>
>>>>> --------------------------
>>>>> Ken Krugler
>>>>> +1 530-210-6378
>>>>> http://www.scaleunlimited.com
>>>>> custom big data solutions & training
>>>>> Hadoop, Cascading, Cassandra & Solr
>>>>>
>>>>>
>>>>>
>>>>>
>>>>
>>>>
>>>> --
>>>> Freundliche Grüße / Kind Regards
>>>>
>>>> Timo Walther
>>>>
>>>> Follow me: @twalthr
>>>> https://www.linkedin.com/in/twalthr
>>>>
>>>
>
> --------------------------
> Ken Krugler
> +1 530-210-6378
> http://www.scaleunlimited.com
> custom big data solutions & training
> Hadoop, Cascading, Cassandra & Solr
>
>
>