[DISCUSS] Move Documentation from Wiki to Documentation

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

[DISCUSS] Move Documentation from Wiki to Documentation

Aljoscha Krettek-2
Hi,
I recently was checking out the wiki because I want to add a page for FLIPs
(Flink Improvement Proposals, see that other mail thread.). I noticed that
we have some documentation there that IMHO should reside in the proper
Flink documentation. Specifically, I'm talking about these:

 -
https://cwiki.apache.org/confluence/display/FLINK/Remote+Debugging+of+Flink+Clusters
 -
https://cwiki.apache.org/confluence/display/FLINK/Variables+Closures+vs.+Broadcast+Variables
 - https://cwiki.apache.org/confluence/display/FLINK/Flink+Internals this
one is very sparse and might have some overlap with the internals
documentation in the Flink doc.
 -
https://cwiki.apache.org/confluence/display/FLINK/Hadoop+Versions+and+Dependency+Shading

What do you think about moving these to the documentation we have in the
Flink repo, i.e. the one available at
https://ci.apache.org/projects/flink/flink-docs-master/?

Cheers,
Aljoscha
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Move Documentation from Wiki to Documentation

Stephan Ewen
I would say that all user-relevant stuff should generally go to the docs.
In that sense, I agree with you for most of the links you mentioned.

The pages relevant to contributors only (like Hadoop Dependency shading)
can be in the Wiki

Greetings,
Stephan


On Fri, Jul 8, 2016 at 2:56 PM, Aljoscha Krettek <[hidden email]>
wrote:

> Hi,
> I recently was checking out the wiki because I want to add a page for FLIPs
> (Flink Improvement Proposals, see that other mail thread.). I noticed that
> we have some documentation there that IMHO should reside in the proper
> Flink documentation. Specifically, I'm talking about these:
>
>  -
>
> https://cwiki.apache.org/confluence/display/FLINK/Remote+Debugging+of+Flink+Clusters
>  -
>
> https://cwiki.apache.org/confluence/display/FLINK/Variables+Closures+vs.+Broadcast+Variables
>  - https://cwiki.apache.org/confluence/display/FLINK/Flink+Internals this
> one is very sparse and might have some overlap with the internals
> documentation in the Flink doc.
>  -
>
> https://cwiki.apache.org/confluence/display/FLINK/Hadoop+Versions+and+Dependency+Shading
>
> What do you think about moving these to the documentation we have in the
> Flink repo, i.e. the one available at
> https://ci.apache.org/projects/flink/flink-docs-master/?
>
> Cheers,
> Aljoscha
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Move Documentation from Wiki to Documentation

Ufuk Celebi-2
+1

I really like the re-organization you just did [1]! :-) Thanks!

Is there a way to reflect this in the left-side navigation as well by
having all User/Contributors/... child pages grouped together?


[1] https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home

On Mon, Jul 11, 2016 at 12:18 PM, Stephan Ewen <[hidden email]> wrote:

> I would say that all user-relevant stuff should generally go to the docs.
> In that sense, I agree with you for most of the links you mentioned.
>
> The pages relevant to contributors only (like Hadoop Dependency shading)
> can be in the Wiki
>
> Greetings,
> Stephan
>
>
> On Fri, Jul 8, 2016 at 2:56 PM, Aljoscha Krettek <[hidden email]>
> wrote:
>
>> Hi,
>> I recently was checking out the wiki because I want to add a page for FLIPs
>> (Flink Improvement Proposals, see that other mail thread.). I noticed that
>> we have some documentation there that IMHO should reside in the proper
>> Flink documentation. Specifically, I'm talking about these:
>>
>>  -
>>
>> https://cwiki.apache.org/confluence/display/FLINK/Remote+Debugging+of+Flink+Clusters
>>  -
>>
>> https://cwiki.apache.org/confluence/display/FLINK/Variables+Closures+vs.+Broadcast+Variables
>>  - https://cwiki.apache.org/confluence/display/FLINK/Flink+Internals this
>> one is very sparse and might have some overlap with the internals
>> documentation in the Flink doc.
>>  -
>>
>> https://cwiki.apache.org/confluence/display/FLINK/Hadoop+Versions+and+Dependency+Shading
>>
>> What do you think about moving these to the documentation we have in the
>> Flink repo, i.e. the one available at
>> https://ci.apache.org/projects/flink/flink-docs-master/?
>>
>> Cheers,
>> Aljoscha
>>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Move Documentation from Wiki to Documentation

Aljoscha Krettek-2
I'm not sure, I'll try to figure that out.

On Wed, 13 Jul 2016 at 12:15 Ufuk Celebi <[hidden email]> wrote:

> +1
>
> I really like the re-organization you just did [1]! :-) Thanks!
>
> Is there a way to reflect this in the left-side navigation as well by
> having all User/Contributors/... child pages grouped together?
>
>
> [1] https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home
>
> On Mon, Jul 11, 2016 at 12:18 PM, Stephan Ewen <[hidden email]> wrote:
> > I would say that all user-relevant stuff should generally go to the docs.
> > In that sense, I agree with you for most of the links you mentioned.
> >
> > The pages relevant to contributors only (like Hadoop Dependency shading)
> > can be in the Wiki
> >
> > Greetings,
> > Stephan
> >
> >
> > On Fri, Jul 8, 2016 at 2:56 PM, Aljoscha Krettek <[hidden email]>
> > wrote:
> >
> >> Hi,
> >> I recently was checking out the wiki because I want to add a page for
> FLIPs
> >> (Flink Improvement Proposals, see that other mail thread.). I noticed
> that
> >> we have some documentation there that IMHO should reside in the proper
> >> Flink documentation. Specifically, I'm talking about these:
> >>
> >>  -
> >>
> >>
> https://cwiki.apache.org/confluence/display/FLINK/Remote+Debugging+of+Flink+Clusters
> >>  -
> >>
> >>
> https://cwiki.apache.org/confluence/display/FLINK/Variables+Closures+vs.+Broadcast+Variables
> >>  - https://cwiki.apache.org/confluence/display/FLINK/Flink+Internals
> this
> >> one is very sparse and might have some overlap with the internals
> >> documentation in the Flink doc.
> >>  -
> >>
> >>
> https://cwiki.apache.org/confluence/display/FLINK/Hadoop+Versions+and+Dependency+Shading
> >>
> >> What do you think about moving these to the documentation we have in the
> >> Flink repo, i.e. the one available at
> >> https://ci.apache.org/projects/flink/flink-docs-master/?
> >>
> >> Cheers,
> >> Aljoscha
> >>
>