Hey Maximilian Alber,
I don't know if you are interested in contributing in Flink, but if you
would like to, these small fixes to the documentation are really helpful
for us!
Its actually quite easy to work with the documentation locally. It is
located in the "docs/" directory of the Flink source.
There is also a "build.sh" script, that will run a local webserver which is
presenting the docs at localhost:4000.
So you can read the Flink docs on your machine and make these small typo
fixes as you spot them.
In the end you commit the stuff to your github and open a pull request for
us ;)

On Thu, Jun 25, 2015 at 2:45 PM, Maximilian Alber <
alber.maximil...@gmail.com> wrote:

> Another one: in the stream guide under "Connecting to the outside world"
> "Sources" I guess one "by" should be a "be".
>
>
> http://ci.apache.org/projects/flink/flink-docs-master/apis/streaming_guide.html
>
> On Thu, Jun 25, 2015 at 2:42 PM, Maximilian Michels <m...@apache.org>
> wrote:
>
>> Thanks Max. I think the documentation has grown a lot and needs an
>> overhaul. We should remove the unnecessary non-Flink-related stuff (e.g.
>> configuring ssh keys in the setup guide). I like your idea of having an
>> "essential" guide that just covers the basics for people already familiar
>> with other big data projects. It would be great if somebody could spare
>> time to work on that.
>>
>> On Thu, Jun 25, 2015 at 2:31 PM, Maximilian Alber <
>> alber.maximil...@gmail.com> wrote:
>>
>>> Something different. I just read through the Spark documentation and
>>> yours. While the Spark one is quite unstructured and easy to understand,
>>> yours is structured and really detailed. It's great that you have that in
>>> depth documentation, but I would recommend you to make a boiled-down page
>>> with just the basic stuff. Which would ease the life of beginners.
>>>
>>> Cheers,
>>> Max
>>>
>>> On Thu, Jun 25, 2015 at 2:20 PM, Chiwan Park <chiwanp...@apache.org>
>>> wrote:
>>>
>>>> How to contribute, and coding guidelines are also duplicated on the web
>>>> site and the documentation.
>>>> I think this duplication is not needed. We need to merge the
>>>> duplication.
>>>>
>>>> Regards,
>>>> Chiwan Park
>>>>
>>>> > On Jun 25, 2015, at 9:01 PM, Maximilian Michels <m...@apache.org>
>>>> wrote:
>>>> >
>>>> > Thanks. Fixed. Actually, that one is not linked anywhere, right? Just
>>>> realized the FAQ page is duplicated on the web site and the Flink
>>>> documentation. So there is
>>>> http://ci.apache.org/projects/flink/flink-docs-master/faq.html and
>>>> http://flink.apache.org/faq.html
>>>> >
>>>> > I'm guessing somebody wanted a FAQ independent of the documentation
>>>> version. However, I don't see how we will maintain multiple FAQs. The two
>>>> have already diverged quite a bit and merging them is not trivial.
>>>> >
>>>> > On Thu, Jun 25, 2015 at 11:40 AM, Maximilian Alber <
>>>> alber.maximil...@gmail.com> wrote:
>>>> > Another one: on
>>>> > http://ci.apache.org/projects/flink/flink-docs-master/faq.html
>>>> > in the "What is parallelism? How do I set it?" Section the links are
>>>> broken.
>>>> >
>>>> > Cheers,
>>>> > Max
>>>> >
>>>> > On Wed, Jun 24, 2015 at 9:52 AM, Maximilian Michels <m...@apache.org>
>>>> wrote:
>>>> > Hi Max,
>>>> >
>>>> > Thanks for noticing! Fixed on the master and for the 0.9.1 release.
>>>> >
>>>> > Cheers,
>>>> > Max
>>>> >
>>>> > On Tue, Jun 23, 2015 at 5:09 PM, Maximilian Alber <
>>>> alber.maximil...@gmail.com> wrote:
>>>> > Hi Flinksters,
>>>> >
>>>> > just some minor:
>>>> >
>>>> http://ci.apache.org/projects/flink/flink-docs-master/setup/yarn_setup.html
>>>> > in the second code sample should be
>>>> > ./bin/flink run -m yarn-cluster -yn 4 -yjm 1024 -ytm 4096
>>>> ./examples/flink-java-examples-0.9-SNAPSHOT-WordCount.jar
>>>> > instead of:
>>>> > ./bin/flink -m yarn-cluster -yn 4 -yjm 1024 -ytm 4096
>>>> ./examples/flink-java-examples-0.9-SNAPSHOT-WordCount.jar
>>>> >
>>>> > Cheers,
>>>> > Max
>>>> >
>>>> >
>>>> >
>>>>
>>>>
>>>>
>>>>
>>>>
>>>
>>
>

Reply via email to