Re: [che-dev] Working with documentation modules

[Robert Kratky <rkratky@xxxxxxxxxx>]

On 01/21/2019 05:49 PM, Mario wrote:

> Thank you Robert for setting this up. To contribute I (or someone else)
> need to start with:
>
> 1) Choosing a "user story" marked as P1 from the outline described in [1]

Yes. Also, please note that Supriya has already started to assign these topics to the individual guides (end of the google doc) and convert them to action-oriented wording.

> 2) Creating an issue about it in [2] and assign it to myself

Yes, unless an issue already exists for this elsewhere, such as the plug-in broker docs issue at https://github.com/redhat-developer/rh-che/issues/1155

> Is that correct?

Thanks!

Regards,
Robert


> [1]
> https://docs.google.com/document/d/1qAZ0D6_Su4mvBjwWuEblnJEqkx1RVXH9DaObnq-qleI/
> [2] https://github.com/eclipse/che-docs/
>
>
> On Mon, Jan 21, 2019 at 4:03 PM Robert Kratky <rkratky@xxxxxxxxxx> wrote:
>
> > Hi,
> >
> > I put together a short doc [1] with hopefully enough info (workflow,
> > principles, resources) to get anyone interested started with authoring (Che
> > 7) docs using Red Hat's module templates.
> >
> > I tried to keep it as concise as possible, so let me know if important
> > info is missing.
> >
> > The docs team much appreciates any help it can get -- in return, we'll try
> > to make the experience (hopefully) painless. For example, we'll always make
> > an attempt to prepare the requisite modular structure for the user stories
> > you choose to document.
> >
> > In order to be able to do that, we ask for whatever initial info you might
> > be able to provide -- a bullet list of required actions, existing docs,
> > presentation slides, etc.
> >
> > Thanks.
> >
> > [1]
> > https://docs.google.com/document/d/1qAZ0D6_Su4mvBjwWuEblnJEqkx1RVXH9DaObnq-qleI/
> >
> > Regards,
> >
> > --
> > Robert Krátký
> > P. Technical Writer, CCS
> > Red Hat