Re: Apache Atlas newbie alert -- atlas-dev & documentation

[Nigel Jones <ni...@cherrybyte.me.uk>]

To throw a few more thoughts in:

One could check-in the design to git in say a new folder
docs/proposed-features, as this would provide for versioning, and JIRAs/git
can be used to manage. However it's fairly contributor led and serial - and
problematic for anyone who's not yet a commiter

Another option would be to use the review board tool, but this is more
oriented around code review than doc review and could be cumbersome

My understanding is the wiki is mostly read only, so perhaps
jira+attachments is the most accessible, pragmatic approach for now for
early-stage work, progressing to checked in docs in the source tree as the
feature gets accepted/evolved?

On Mon, 12 Dec 2016 at 15:05 Stephanie Hazlewood <st...@ca.ibm.com>
wrote:

> Hermanth,
>
> Thank you kindly for your response and identifying these options - it's
> been very helpful.  I see benefits in each approach- and would like to
> explore both options.
>
> If there is an admin that could help me with access to the Atlas wiki to
> create a few pages to support discussion that would be fantastic.
>
> The thought is to publish for discussion the rationale/high level thinking
> and architecture in the wiki (hopefully generate some comments within the
> wiki itself) and then delve into the next level of detail using Jira and
> provide targetted documentation for the kinds of features that would
> underpin the capability.   There would be some overlap, but hoping with
> these approaches we can broaden the scope of contribution/discussion and
> perhaps also revitalize the use of the wiki.
>
> Looking forward to further discussion.
>
> Best regards,
> Stephanie
>
>
>
>
> From:   Hemanth Yamijala <yh...@gmail.com>
> To:     Stephanie Hazlewood/Toronto/IBM@IBMCA,
> dev@atlas.incubator.apache.org
> Date:   2016/12/09 01:28 AM
> Subject:        Re: Apache Atlas newbie alert -- atlas-dev & documentation
>
>
>
> Stephanie,
>
> Thank you for the email. This question can most certainly be asked on
> the dev mailing list, and hence I took the liberty of including that
> here. Let's continue discussion here.
>
> If I understand correctly, you would like to post a design document
> for ATLAS-1095 to discuss in depth. It would be extremely useful to do
> that. There are a couple of options:
>
> * For fairly large enhancements, you could write a design document and
> attach it to the JIRA and solicit feedback from the community on that.
> Part of the feedback discussion usually occurs on the JIRA comments.
> And revisions to the document can be reposted once there is
> significant change. This would be a preferred way, IMHO. You can see
> how this worked out in ATLAS-511 as an example.
> * The other option is the Atlas Wiki:
> https://cwiki.apache.org/confluence/display/ATLAS/Atlas+Home - but I
> have rarely seen it being used, and while I have read access, I don't
> know see to add pages etc. Maybe someone on the admin list can help
> with that.
>
> Please let me know if this answers your questions.
>
> Thanks
> Hemanth
>
> On Fri, Dec 9, 2016 at 5:51 AM, Stephanie Hazlewood
> <st...@ca.ibm.com> wrote:
> > Hemanth,
> >
> > My apologies for not posting directly to the atlas-dev list. I noticed
> on
> > the mail list that you typically answered questions around documentation
> -
> > but being new - not sure if this is a good question to ask on the dev
> list
> > itself as it is not really applicable to a current feature being
> > implemented.
> >
> > Is it possible to post to the website architecture/design/terminology
> > material for the purpose of collaboration/discussion?   I have a fair
> amount
> > of material supporting a Jira (ATLAS-1095) opened last summer for a
> > framework that IBM would like to propose and contribute to Apache Atlas.
> >
> > Best regards,
> > Stephanie
> >
> >
> > Stephanie Hazlewood
> > STSM, Strategic Initiatives
> > IBM Analytics
> > e: stephanie@ca.ibm.com
> > p: 905-413-5292
> > m: 416-529-9987
>
>
>
>
>
>