Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

I have added all PMC that had an account on the confluence wiki to be administrators. Current list of administrators is: Aljoscha Krettek (aljoscha) Davor Bonaci (davor) Daniel Kulp (dkulp) Gavin (gmcdonald) Josh Wills (jwills) Kenneth Knowles (kenn) Lukasz Cwik (lukecwik) Jean-Baptiste Onofré (na

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Your doc looks good to me. It looks like only one question remains: should it be a Confluence or Github wiki. I see other Apache projects using both, so it seems like either one is possible with support of the Beam community. It might be time to call a vote on this? Andrew On Fri, Jul 13, 2018 at

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Hello everyone it's Mikhail and I'm here to revive this long-sleeping thread. I have summarized discussion above into a design/proposal document . The initial proposal is what I consider the best approach, so it is

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Hi Everyone, (a) should we do it? -- I like the idea of having a wiki, yes. Mainly to differentiate the documentation we cater to users and the one we cater to contributors. For things like user examples, and more demo-y content, I'd suggest we still host it in the Website. (b) what should go th

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

+1 for having Wiki for devs and users. Even though editing interface is not so native and obvious (comparing to Google docs), but, at least, it will be already put in one place and should be much more easy to search and discover. The only my concern about Wiki (based on using it in other differ

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

On Mon, Jun 11, 2018 at 2:40 PM Kenneth Knowles wrote: > OK, yea, that all makes sense to me. Like this? > > - site/documentation: writing just for users > - site/contribute: basic stuff as-is, writing for users to entice them, > links to the next... > - wiki/contributors: contributors writing

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Hi all,+1 on targeting different media/sections to different categories of people like Kenn said.Also, IMHO copying what is in the design docs does not make a lot of sense now that we have then indexed on the website. But putting the knowledge we (beam devs) have inside our heads and that are not

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

+1 for having a wiki. One comment: Is there a specific reason for it to be a Confluence engine? I know that we use JIRA by Atlassian, but we also utilize Github that has its own wiki engine that is closer to code and much more lightweight. I would prefer wiki hosted on Github. --Mikhail On M

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

OK, yea, that all makes sense to me. Like this? - site/documentation: writing just for users - site/contribute: basic stuff as-is, writing for users to entice them, links to the next... - wiki/contributors: contributors writing just for each other And you also have - wiki/users: users writin

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

On Fri, Jun 8, 2018 at 2:18 PM Kenneth Knowles wrote: > I disagree strongly here - I don't think the wiki will have appropriate > polish for users. Even if carefully polished I don't think the presentation > style is right, and it is not flexible. Power users will find it, of course. > I wasn't

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Yup, I'm "kenn". Thanks! To the thread - if you want write access, please ask. Committers should certainly have it (but I'll do it lazily) and beyond that I think is up for discussion. Kenn On Mon, Jun 11, 2018 at 5:52 AM Daniel Kulp wrote: > Neither you nor JB was setup to be able to do anyth

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Neither you nor JB was setup to be able to do anything with the Wiki. I just enabled JB and yourself (assume “kenn” is you) to have permission to administer the space so you should be able to add other people. Dan > On Jun 9, 2018, at 9:57 AM, Kenneth Knowles wrote: > > Yea, we have one

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Sure, let me change the permissions. Regards JB On 09/06/2018 15:57, Kenneth Knowles wrote: > Yea, we have one but it seems to not be set up quite right. JB you are > the admin from the original incubation. Can you check the permissions? > Also make some more admins (maybe all the PMC to start wi

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Yea, we have one but it seems to not be set up quite right. JB you are the admin from the original incubation. Can you check the permissions? Also make some more admins (maybe all the PMC to start with). I would like to help out. https://cwiki.apache.org/confluence/display/BEAM/ https://issues.apa

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

+1 That's funny, because AFAIR, it's what we discussed in the early stage of the project. We can also link wiki pages on the website if we want to provide details. AFAIR, we already have a confluence wiki space for Beam. Regards JB On 07/06/2018 22:23, Kenneth Knowles wrote: > Hi all, > > I've

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

+1 I don't have much to add to the debate, except to state that Beam currently has a fragmentation problem for user documentation. I would support limiting the wiki to non-user focused docs to prevent additional fragmentation. We have first-class website pages [1], documentation embedded in Javad

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Replies in line to keep on the discussion of what we might want to put in different venues. But it does sound like there's enough support to at least get started on getting our wiki set up to be accessible. For general context - Our wiki "exists" here: https://cwiki.apache.org/confluence/display

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

The use of wiki vs. docs vs. the (repo-backed) website seems to be one of convenience vs. polish, and totally orthogonal to dev vs. user-facing stuff. I'm not opposed to a wiki, but personally I think a lot of our dev-facing docs (e.g. testing, ptransform style guide, portability overview) benefit

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

+1 most of the contributor material could live on Wiki and there it will be easier to maintain (perhaps the lower bar for updates will lead to more information and increased maintenance). Contribution policy related material should remain on the website and go through proper review/versioning. On

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

(a) Yes. (b) I'm interested in putting documentation for contributors there. (test triage guide, precommit and postcommit guidelines, processes, etc.) It'd be faster than having to go through the motions of a github pull request and a review process. (c) Anything that goes to a wide audience, such

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

+1 It would be really nice to have a lightweight place to share that is more searchable then random Google docs. Andrew On Fri, Jun 8, 2018 at 9:35 AM Anton Kedin wrote: > +1 > > (a) we should; > (b) I think it will be a good place for all of the things you list; > (c) introductory things, like

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

+1 (a) we should; (b) I think it will be a good place for all of the things you list; (c) introductory things, like "getting started", or "programming guide" that people not deeply involved in the project would expect to find on beam.apache.org should stay there, not in the wiki; On Fri, Jun 8, 2

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

Hi Kenn,I'm +1 of course. I remember that you and I and others discussed in a similar thread about dev facing docs but it got lost at some point in time.IMHO I would add - runners specifics (e.g. how runners implement state or timer, how they split data into bundles, etc...)- probably putting onl

Re: [DISCUSS] Use Confluence wiki for non-user-facing stuff

+1. It would be very helpful to have dev-facing walkthroughs / technical documentation for relevant aspects of the codebase that aren't user-facing. On Thu, Jun 7, 2018, 1:23 PM Kenneth Knowles wrote: > Hi all, > > I've been in half a dozen conversations recently about whether to have a > wiki a

[DISCUSS] Use Confluence wiki for non-user-facing stuff

Hi all, I've been in half a dozen conversations recently about whether to have a wiki and what to use it for. Some things I've heard: - "why is all this stuff that users don't care about here?" - "can we have a lighter weight place to put technical references for contributors" So I want to con