Documentation in the master

[mxm]

Hey there,

Just letting you know, we now have the documentation of all releases,
including the latest snapshot version, available on the Flink website.

While checking out the latest master documentation, Marton and me were
wondering if some of the documentation should really be available for
the general public. In particular, [1] which is just a stub. I think
it is ok to have work-in-progress documentation in the latest snapshot
but maybe that is up for debate.

Also, I came across some problems with SVG files in the documentation
[2]. The files are correctly embedded and linked but are corrupted.
Would be great if that could be fixed. Firefox complains "Attempt to
use XML processing instruction in HTML" in the first line of the SVG.

Best regards,
Max

[1] http://ci.apache.org/projects/flink/flink-docs-master/internal_distributed_akka.html
[2] http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html

[Stephan Ewen]

Great, thanks Max!

Concerning (1), in the snapshot master, we can have stubs, IMHO.

Concerning (2), how do we fix the SVG files?

On Wed, Mar 4, 2015 at 3:30 PM, Maximilian Michels <[hidden email]> wrote:

> Hey there,
>
> Just letting you know, we now have the documentation of all releases,
> including the latest snapshot version, available on the Flink website.
>
> While checking out the latest master documentation, Marton and me were
> wondering if some of the documentation should really be available for
> the general public. In particular, [1] which is just a stub. I think
> it is ok to have work-in-progress documentation in the latest snapshot
> but maybe that is up for debate.
>
> Also, I came across some problems with SVG files in the documentation
> [2]. The files are correctly embedded and linked but are corrupted.
> Would be great if that could be fixed. Firefox complains "Attempt to
> use XML processing instruction in HTML" in the first line of the SVG.
>
> Best regards,
> Max
>
> [1]
> http://ci.apache.org/projects/flink/flink-docs-master/internal_distributed_akka.html
> [2]
> http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html
>

[mxm]

(2) I found out, it's actually not the SVG but the Webserver which
sets the wrong content type for svg files.

I checked on the ci.apache.org server. It serves SVGs as
"Content-Type: text/html" which lets the browser assume html is in the
SVG file but it is XML. The correct content type would be something
like "image/svg+xml".

I'll ask Infra to fix that.

On Wed, Mar 4, 2015 at 3:36 PM, Stephan Ewen <[hidden email]> wrote:

> Great, thanks Max!
>
> Concerning (1), in the snapshot master, we can have stubs, IMHO.
>
> Concerning (2), how do we fix the SVG files?
>
> On Wed, Mar 4, 2015 at 3:30 PM, Maximilian Michels <[hidden email]> wrote:
>
>> Hey there,
>>
>> Just letting you know, we now have the documentation of all releases,
>> including the latest snapshot version, available on the Flink website.
>>
>> While checking out the latest master documentation, Marton and me were
>> wondering if some of the documentation should really be available for
>> the general public. In particular, [1] which is just a stub. I think
>> it is ok to have work-in-progress documentation in the latest snapshot
>> but maybe that is up for debate.
>>
>> Also, I came across some problems with SVG files in the documentation
>> [2]. The files are correctly embedded and linked but are corrupted.
>> Would be great if that could be fixed. Firefox complains "Attempt to
>> use XML processing instruction in HTML" in the first line of the SVG.
>>
>> Best regards,
>> Max
>>
>> [1]
>> http://ci.apache.org/projects/flink/flink-docs-master/internal_distributed_akka.html
>> [2]
>> http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html
>>

[Henry Saputra]

This is great news, Max!

Thanks for picking up the task.

Sorry I was late filing issue for this but did it anyway: FLINK-1647
I have assigned it to you so feel free to mark it as Resolved.

Just small comment, next time please do let everyone know via dev@
list that you are working on it to make sure no duplicate effort
happening.

Great job.

- Henry

On Wed, Mar 4, 2015 at 6:30 AM, Maximilian Michels <[hidden email]> wrote:

> Hey there,
>
> Just letting you know, we now have the documentation of all releases,
> including the latest snapshot version, available on the Flink website.
>
> While checking out the latest master documentation, Marton and me were
> wondering if some of the documentation should really be available for
> the general public. In particular, [1] which is just a stub. I think
> it is ok to have work-in-progress documentation in the latest snapshot
> but maybe that is up for debate.
>
> Also, I came across some problems with SVG files in the documentation
> [2]. The files are correctly embedded and linked but are corrupted.
> Would be great if that could be fixed. Firefox complains "Attempt to
> use XML processing instruction in HTML" in the first line of the SVG.
>
> Best regards,
> Max
>
> [1] http://ci.apache.org/projects/flink/flink-docs-master/internal_distributed_akka.html
> [2] http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html

[mxm]

Hi Henry,

There wasn't a specific issue for pushing the latest documentation to
the website but it was covered by the issue of automatically building
the latest documentation [1].

I assigned the issue [1] to myself. So I think it's ok to skip the dev
mailing list then.

Kind regards,
Max

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

On Wed, Mar 4, 2015 at 4:57 PM, Henry Saputra <[hidden email]> wrote:

> This is great news, Max!
>
> Thanks for picking up the task.
>
> Sorry I was late filing issue for this but did it anyway: FLINK-1647
> I have assigned it to you so feel free to mark it as Resolved.
>
> Just small comment, next time please do let everyone know via dev@
> list that you are working on it to make sure no duplicate effort
> happening.
>
> Great job.
>
> - Henry
>
> On Wed, Mar 4, 2015 at 6:30 AM, Maximilian Michels <[hidden email]> wrote:
>> Hey there,
>>
>> Just letting you know, we now have the documentation of all releases,
>> including the latest snapshot version, available on the Flink website.
>>
>> While checking out the latest master documentation, Marton and me were
>> wondering if some of the documentation should really be available for
>> the general public. In particular, [1] which is just a stub. I think
>> it is ok to have work-in-progress documentation in the latest snapshot
>> but maybe that is up for debate.
>>
>> Also, I came across some problems with SVG files in the documentation
>> [2]. The files are correctly embedded and linked but are corrupted.
>> Would be great if that could be fixed. Firefox complains "Attempt to
>> use XML processing instruction in HTML" in the first line of the SVG.
>>
>> Best regards,
>> Max
>>
>> [1] http://ci.apache.org/projects/flink/flink-docs-master/internal_distributed_akka.html
>> [2] http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html

[Henry Saputra]

Hi Max,

Sounds good to me. Thanks again for picking up the task.

- Henry

On Wed, Mar 4, 2015 at 8:07 AM, Maximilian Michels <[hidden email]> wrote:

> Hi Henry,
>
> There wasn't a specific issue for pushing the latest documentation to
> the website but it was covered by the issue of automatically building
> the latest documentation [1].
>
> I assigned the issue [1] to myself. So I think it's ok to skip the dev
> mailing list then.
>
> Kind regards,
> Max
>
> [1] https://issues.apache.org/jira/browse/FLINK-1370
>
> On Wed, Mar 4, 2015 at 4:57 PM, Henry Saputra <[hidden email]> wrote:
>> This is great news, Max!
>>
>> Thanks for picking up the task.
>>
>> Sorry I was late filing issue for this but did it anyway: FLINK-1647
>> I have assigned it to you so feel free to mark it as Resolved.
>>
>> Just small comment, next time please do let everyone know via dev@
>> list that you are working on it to make sure no duplicate effort
>> happening.
>>
>> Great job.
>>
>> - Henry
>>
>> On Wed, Mar 4, 2015 at 6:30 AM, Maximilian Michels <[hidden email]> wrote:
>>> Hey there,
>>>
>>> Just letting you know, we now have the documentation of all releases,
>>> including the latest snapshot version, available on the Flink website.
>>>
>>> While checking out the latest master documentation, Marton and me were
>>> wondering if some of the documentation should really be available for
>>> the general public. In particular, [1] which is just a stub. I think
>>> it is ok to have work-in-progress documentation in the latest snapshot
>>> but maybe that is up for debate.
>>>
>>> Also, I came across some problems with SVG files in the documentation
>>> [2]. The files are correctly embedded and linked but are corrupted.
>>> Would be great if that could be fixed. Firefox complains "Attempt to
>>> use XML processing instruction in HTML" in the first line of the SVG.
>>>
>>> Best regards,
>>> Max
>>>
>>> [1] http://ci.apache.org/projects/flink/flink-docs-master/internal_distributed_akka.html
>>> [2] http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html

[Ufuk Celebi-2]

Nice, Max! :)

On 04 Mar 2015, at 15:36, Stephan Ewen <[hidden email]> wrote:

> Great, thanks Max!
>
> Concerning (1), in the snapshot master, we can have stubs, IMHO.

I agree :)

[mxm]

SVG image display has been fixed by the build team.

http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html

On Wed, Mar 4, 2015 at 4:38 PM, Maximilian Michels <[hidden email]> wrote:

> (2) I found out, it's actually not the SVG but the Webserver which
> sets the wrong content type for svg files.
>
> I checked on the ci.apache.org server. It serves SVGs as
> "Content-Type: text/html" which lets the browser assume html is in the
> SVG file but it is XML. The correct content type would be something
> like "image/svg+xml".
>
> I'll ask Infra to fix that.
>
> On Wed, Mar 4, 2015 at 3:36 PM, Stephan Ewen <[hidden email]> wrote:
> > Great, thanks Max!
> >
> > Concerning (1), in the snapshot master, we can have stubs, IMHO.
> >
> > Concerning (2), how do we fix the SVG files?
> >
> > On Wed, Mar 4, 2015 at 3:30 PM, Maximilian Michels <[hidden email]>
> wrote:
> >
> >> Hey there,
> >>
> >> Just letting you know, we now have the documentation of all releases,
> >> including the latest snapshot version, available on the Flink website.
> >>
> >> While checking out the latest master documentation, Marton and me were
> >> wondering if some of the documentation should really be available for
> >> the general public. In particular, [1] which is just a stub. I think
> >> it is ok to have work-in-progress documentation in the latest snapshot
> >> but maybe that is up for debate.
> >>
> >> Also, I came across some problems with SVG files in the documentation
> >> [2]. The files are correctly embedded and linked but are corrupted.
> >> Would be great if that could be fixed. Firefox complains "Attempt to
> >> use XML processing instruction in HTML" in the first line of the SVG.
> >>
> >> Best regards,
> >> Max
> >>
> >> [1]
> >>
> http://ci.apache.org/projects/flink/flink-docs-master/internal_distributed_akka.html
> >> [2]
> >>
> http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html
> >>
>

[Henry Saputra]

Awesome! Thanks for the update

- Henry

On Mon, Mar 16, 2015 at 10:40 AM, Maximilian Michels <[hidden email]> wrote:

> SVG image display has been fixed by the build team.
>
> http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html
>
> On Wed, Mar 4, 2015 at 4:38 PM, Maximilian Michels <[hidden email]> wrote:
>
>> (2) I found out, it's actually not the SVG but the Webserver which
>> sets the wrong content type for svg files.
>>
>> I checked on the ci.apache.org server. It serves SVGs as
>> "Content-Type: text/html" which lets the browser assume html is in the
>> SVG file but it is XML. The correct content type would be something
>> like "image/svg+xml".
>>
>> I'll ask Infra to fix that.
>>
>> On Wed, Mar 4, 2015 at 3:36 PM, Stephan Ewen <[hidden email]> wrote:
>> > Great, thanks Max!
>> >
>> > Concerning (1), in the snapshot master, we can have stubs, IMHO.
>> >
>> > Concerning (2), how do we fix the SVG files?
>> >
>> > On Wed, Mar 4, 2015 at 3:30 PM, Maximilian Michels <[hidden email]>
>> wrote:
>> >
>> >> Hey there,
>> >>
>> >> Just letting you know, we now have the documentation of all releases,
>> >> including the latest snapshot version, available on the Flink website.
>> >>
>> >> While checking out the latest master documentation, Marton and me were
>> >> wondering if some of the documentation should really be available for
>> >> the general public. In particular, [1] which is just a stub. I think
>> >> it is ok to have work-in-progress documentation in the latest snapshot
>> >> but maybe that is up for debate.
>> >>
>> >> Also, I came across some problems with SVG files in the documentation
>> >> [2]. The files are correctly embedded and linked but are corrupted.
>> >> Would be great if that could be fixed. Firefox complains "Attempt to
>> >> use XML processing instruction in HTML" in the first line of the SVG.
>> >>
>> >> Best regards,
>> >> Max
>> >>
>> >> [1]
>> >>
>> http://ci.apache.org/projects/flink/flink-docs-master/internal_distributed_akka.html
>> >> [2]
>> >>
>> http://ci.apache.org/projects/flink/flink-docs-master/internal_general_arch.html
>> >>
>>