Documentation Feedback
Inbox
x

Nadav Halevy <nhalevy@redhat.com>
20 Aug 2018, 11:57
to dcadzow, cminkema, Ofer, Nathan

Hello Derek and Cheryl,

My name is Nadav Halevy and I recently joined Red Hat as an intern in the Israel office.

One of the first tasks I have been assigned is to install RHOSP 13 via the Director Installation and Usage guide and to give feedback if I encounter instructions that I think are not clear enough or otherwise have suggestions that might enable the end-user to have a clearer understanding of the instructions.

So far I have a number of suggestions and I wanted to ask how you like for me to share them? Should I open a bug in Bugzilla? If it is it possible for you to give me access to a Google Docs document which I can then edit and add comments then I think that is the best way.

Many thanks,

Nadav


Nathan Levinkind <nlevinki@redhat.com>
20 Aug 2018, 13:16
to Lucy, me, Derek, Cheryl, Ofer

adding Lucy,
I am in favor for comments permission on a Google doc, my 2 cents.
--
Nathan Levinkind
QE Senior Manager, Red Hat Openstack


Lucy Bopf <lbopf@redhat.com>
21 Aug 2018, 08:16
to Nathan, me, Derek, Cheryl, Ofer

Hi all,

Thanks for adding me here, Nathan.

I agree that a Google doc with the current guide pasted in is probably the smoothest way to do a whole guide review. We can then take that and organize the feedback into BZs for review.

I'm happy to create this, but I will hold off for the moment to make sure there are no other suggestions we should explore.


Kind Regards,

Lucy

LUCY BOPF

DOCUMENTATION PROGRAM MANAGER

Red Hat


lbopf@redhat.com    T: +61-7-3514-7181     IM: lbopf




Ofer Blaut <oblaut@redhat.com>
21 Aug 2018, 09:07
to Lucy, Nathan, me, Derek, Cheryl

Hi Lucy

If you use git, Nadva might use it to add comments or even fixes for you to review

What do you think ?

Thanks

Ofer





Lucy Bopf <lbopf@redhat.com>
22 Aug 2018, 07:52
to Ofer, Nathan, me, Derek, Cheryl

Hi everyone,

Ofer, we do use git, but after further discussion with Derek, we agreed that we'd like the feedback to make its way through our established Bugzilla tracking and testing process, and that it would be simpler to capture questions and determine action items in a Google document than in our GitLab interface.

We'd like to approach things in the following way:
We copy the entire document into a Google doc - https://docs.google.com/document/d/1WjCfF75X5gNOwwJ-1-0wtMd7gW7Mo5EItda3JZB1goI/edit?usp=sharing
Nadav uses comments to identify -
Questions that the docs team can answer - unclear wording, broken links, typos
Questions that a DFG (probably Deployment) can answer - whether particular procedures are supported, ideas for streamlined workflows, technical issues
Content that is outdated or does not apply to version 13 - for example, something that might have been removed from the product between 12 and 13 without us being aware
Procedures that are not successful when tested, or lead to different states/outcomes than those documented
Validation procedures that don't clearly explain what to do in the event of a failed validation
Nadav, with the help of the docs team and DFG, identifies the required action item, if any, for each comment.
Nadav raises a BZ against the 'documentation' component with a list of action items for the docs team - the docs team then runs this through our usual prioritization, assignment, and retesting process.
If required, Nadav raises BZs against other 'Red Hat OpenStack' components with any action items for engineering teams.
I've added these same instructions to the opening page of the document. If there are any changes or additions needed, please let me know.

Thanks, Nadav, for taking on this testing assignment, and we look forward to seeing your feedback and working with you!


Kind Regards,

Lucy

LUCY BOPF

DOCUMENTATION PROGRAM MANAGER

Red Hat


lbopf@redhat.com    T: +61-7-3514-7181     IM: lbopf