Timeline for Documentation Review & Acceptance

Hello friends, review process is almost done but we haven’t got any feedback from you concerning the changes made. Kindly follow this link and leave a comment on changes made. Thanks in advance.

Friends, I really appreciate the good work you are doing. Its my kind request you spare sometime and give your comments on the changes made on this link. I have reviewed this and this pages and they seem OK. Can someone help reviewing again?

cc @ball, @dkayiwa, @janflowers, @jennifer, @suthagar23, @tendomart, @ruffjm @jthomas, @c.antwi

3 Likes

@jwnasambu, I spent a few minutes during our PM call to look at this request. It’s not very clear what you are asking of expert reviewers.

For example, you say:

Its my kind request you spare sometime and give your comments on the changes made on this link.

When I visit your link, I see a page that appears to be directed toward people who want to contribute documentation changes. As I scroll down the page, I can see a table “Expert Review and Corrections” that contains a redundant “PAGE TITLE” column, a “PAGE LINK” column, and then a “PAGE COMMENTS” column that appears to have a description of changes made to the page.

Okay, so it appears that you’re asking that we review a page in the “Expert Review and Corrections” table? And then what? Am I supposed to reach out personally to the editors and let them know? Am I supposed to add comments into the “Page Comments” column? It’s unclear.

Can we make it easier & more intuitive for reviewers? For example, something like this:

Reviewers: Thank you for your help! After selecting a page to review, please enter your name, review the changes, and then enter either “approved” or “needs work” into the status column (including comments to direct any needed work)

Page Page before changes Changes made Description of changes Reviewer(s) Status Reviewer comments
For Open Web App Developers View original View changes Added and updated information underneath every title listed on that page (What is an OWA, Quick Overview, How To Write An OWA, Examples).
Contributors:Maggie Harder, Olivia Rine, Sam Neupane, Jacob Hansen

Thanks for sparing your time to look through this table. The table was just to guide the person reviewing on the changes made. The "page comment "column give the reviewer the clear picture on the changes made on the “page link” column. Since it appears confusing, let me incorporate the suggested changes. Once again thank you.

@mharder thank you for working tireless to ensure our documents are up to date. We have come up with a new reporting format on this link. kindly edit it basing on what you have been doing so that the review process can kick off.

I have just made the changes as @burke had suggested. Initially we were making changes directly on the original wiki document but now we have to separate the old content from the new content. I have reached out to the writers through PM to fill the information in the table once its done I request you help in reviewing.

@c.antwi @jwnasambu Hello, I just added a new page to the wiki on OWA Unit Testing. I was wondering how I should document that on the “Documentation Review Work Needed” page. Is it okay if I include it in the “Expert Review and Corrections” Table as shown below:

Thanks I have seen it. Am assigning someone to review it.

Hello friends, am reaching out to you to help me review these pages:

@raff and @suthagar23 this page. The previous page is this

@ssemakadde, @janflowers and @rotimi this page. The origin work is this.

@ruhanga and @ball this page the original work is this

@dkayiwa this page. this is the previous work

@burke this and this on this and this previous pages.

@wyclif this page on this previous page.

@dkayiwa this page on this previous page

@tgreensweig and @f4ww4z this page on this previous link

@mozzy how far with page?

Kindly share your feedback or comment on this link on the project you are reviewing.

2 Likes

@jwnasambu alright noted.

@jwnasambu , i made the PR which is just waiting for more review and merging. i think thats all .

@mozzy Thanks. Kindly share the PR so that I assign someone to review it.

1 Like

@jwnasambu . It’s here https://github.com/openmrs/openmrs-book-developer-manual/pull/12

Though I had already shared it in the Documentation Review wiki page you created .

I had checked on the github link you have shared but I just wanted to confirm if it the right page. Thanks let me go though the changes and assign someone else to go through.

Is there a convention for screenshot image size on the wiki? I reviewed changes to the Administering Modules page and they look good; however, I think some readers with smaller monitors might end up horizontally scrolling to read the direction in the 2nd column. It’s a balance between making the image readable up front without zooming and not taking up too much real estate on the page with each image. Given simply tapping on any image brings up a full size version of it, I wonder if we could err on the side of smaller images on the page to avoid horizontal scrolling or taking up space unnecessarily.

If we don’t have one, it might be nice to create a page or set of pages with directions & conventions for managing wiki content. It could include tips like “OpenMRS wiki uses hierarchies: How to create a wiki page in the right location.” and outline some conventions like default image size.

1 Like

Thank you for sparing your time to review the document we really appreciate. @samirkashyap and the group thanks too. Is it okay we look through what @burke has suggested?

Hello friends,
I know you have a tight schedule but I kindly request you spare some few minutes and review the above links and give your comment. Kindly its over due.

@raff, @suthagar23, @ssemakadde, @janflowers, @rotimi. @ruhanga, @ball, @dkayiwa, @f4ww4z @tgreensweig @tendomart and @wyclif

@gcliff and @herbert24 Kindly followup with this and make the changes as suggested.

In case you need any clarification, feel free to reach out to the community.

1 Like

The changes on the page am linked to look fine to me.

Thanks for your time.