Page MenuHomePhabricator

Update Wikimedia's Gerrit documentation for new UI (GWTUI to be superseded by polygerrit)
Closed, DuplicatePublic

Description

We should upgrade the documentation for the new ui. Upstream have begun the stages of removing GWTUI by removing it from *.googlesource.com. Upstream have now removed gwtui from some of the build commands. Upstream is planning to removing it from either 3.1. or 3.0 if 2.16 is released.

We should also document the new work flow as there is now a WIP mode which some users got confused on how to get out of it.

Notes for the students that may be working on this:

  • PolyGerrit is not the default ui, so you have to either add ?polygerrit=1 at the end of the url, or click the footer where it says New UI.

See Also:

Event Timeline

Please do not decline this, as the ui is completely new so users are likely to get loss especially new ones and ones who used GWTUI but want to try out the new ui.

Note that not all features are supported in 2.14 but is mostly completed in 2.15.

So this task will cover both releases so part one is to cover 2.14 then when we get to 2.15, then cover the rest of the features :).

Framawiki added a subscriber: Framawiki.

@Paladox Do you think that it can be a Google-Code-in-2017 task ? Perhaps you can provide an url where the 2.14 is live to help volunteers to deal with it.

Great ! I purpose to mentor this task for Google-Code-in-2017. @Paladox I'd be happy to co-mentor this with you, if yes please add yourself in the mentor list. Here is my opinion about this task, don't hesitate to complete.

So the purpose of this task is to update screenshots that are present in https://www.mediawiki.org/wiki/Gerrit and its subpages. Don't hesitate to add new one when you find that part of the help needs it. The official Wikimedia instance https://gerrit.wikimedia.org/ was not updated yet to the next version of the software, but you can find a test instance at https://gerrit.git.wmflabs.org/r/. I think that you can change screenshots although the update is not yet official, because it will be done in the near future. About the upload, all the files need to be stored in Wikimedia Commons before to be inserted in help pages, so please don't upload files locally to mediawiki.org. The best for naming convention can be to add the version name (2.14) as suffix of existent screenshot filenames, so old files still exists.

Could you clarify steps and provide a clear task description for a new contributor who has never seen or heard of Gerrit before?
When to call this task finished? What is "GWTUI"?

How is a contributor supposed to log in on https://gerrit.git.wmflabs.org/ ? "Register" redirects to https://wikitech.wikimedia.org/wiki/Special:CreateAccount which is only for the production instance at https://gerrit.wikimedia.org ? I hope the test instance on wmflabs.org does not share credentials with the production instance?

In general, GCI tasks must have absolutely clear steps that allow a new contributor to judge whether it's a feasible task.
That avoids disappointments and misunderstandings on both sides (mentor and student).

@Aklapper they not need to register if they click login they can become the admin account.

Could you clarify steps and provide a clear task description for a new contributor who has never seen or heard of Gerrit before?
When to call this task finished? What is "GWTUI"?

How is a contributor supposed to log in on https://gerrit.git.wmflabs.org/ ? "Register" redirects to https://wikitech.wikimedia.org/wiki/Special:CreateAccount which is only for the production instance at https://gerrit.wikimedia.org ? I hope the test instance on wmflabs.org does not share credentials with the production instance?

In general, GCI tasks must have absolutely clear steps that allow a new contributor to judge whether it's a feasible task.
That avoids disappointments and misunderstandings on both sides (mentor and student).

The instance is using puppet so it is using prods puppet class and nope i doint use any production data. I've switched it to using https://ldapauth-gitldap.wmflabs.org/wiki/Main_Page though because it's a puppet class, i carn't really change the register link.

GWTUI is gerrit's old ui being replaced with polygerrit. GWTUI is based on gwt a google tool kit for creating ui with java. Polygerrit is pure html and javascript.

@Aklapper they not need to register if they click login they can become the admin account.

@Zppix im using a ldap config so it dosen't do that anymore. Users have to signup at https://ldapauth-gitldap.wmflabs.org/wiki/Main_Page which then they use that login detail to login into gerrit.git.wmflabs.org.

@Aklapper they not need to register if they click login they can become the admin account.

Ah. But you don't need to tell only me (as I don't plan to work on this) but also a student working on this task. :)
You can edit the task description by clicking Edit Task to include sufficient explanations and steps for contributors. Thanks.

GWTUI is gerrit's old ui being replaced with polygerrit. GWTUI is based on gwt a google tool kit for creating ui with java. Polygerrit is pure html and javascript.

You can edit the task description by clicking Edit Task to include sufficient explanations and steps for contributors. Thanks.

Paladox updated the task description. (Show Details)
Paladox updated the task description. (Show Details)
Aklapper renamed this task from Update doc's for the gerrit new ui to Update Wikimedia's Gerrit documentation for Gerrit's new user interface.Nov 25 2017, 8:09 PM
Aklapper updated the task description. (Show Details)
Aklapper moved this task from Proposed tasks to Information needed on the Google-Code-in-2017 board.

@Paladox: Where is a contributor expected to deliver/create this documentation? Clear steps on expectations welcome.

...which probably means linking to https://www.mediawiki.org/wiki/Help:Editing for a new contributor. :)
(Please always imagine a new contributor who was never worked or seen MediaWiki.)

@Paladox: So you propose to make our current, canonical, [hopefully] valid documentation about our Gerrit 2.13 instance invalid by replacing it with documentation about a future version which we currently do not offer to our user base? Are you sure that is a good idea?

...which probably means linking to https://www.mediawiki.org/wiki/Help:Editing for a new contributor. :)
(Please always imagine a new contributor who was never worked or seen MediaWiki.)

@Paladox: So you propose to make our current, canonical, [hopefully] valid documentation about our Gerrit 2.13 instance invalid by replacing it with documentation about a future version which we currently do not offer to our user base? Are you sure that is a good idea?

We can possibly create docs and add a little note that this is for 2.14. But if you think this is wrong you can remove this from the gc and can be done later.

Well, preparing docs for future changes is a good idea, while just overwriting correct docs might not be. So if you can find a way in between... :)

Aklapper renamed this task from Update Wikimedia's Gerrit documentation for Gerrit's new user interface to Update Wikimedia's Gerrit documentation for new user interface in Gerrit 2.15.Dec 9 2017, 6:05 PM
Aklapper renamed this task from Update Wikimedia's Gerrit documentation for new user interface in Gerrit 2.15 to Update Wikimedia's Gerrit documentation for new user interface in Gerrit 2.14.Dec 10 2017, 4:53 PM
Aklapper updated the task description. (Show Details)

We have updated now.

We should probaly have to add docs on users to enable "Fit to display" (basically line wrapping) as the diff view will look out of place.

We also need to add docs on users setting there user status and for users to name there patches too.

Paladox renamed this task from Update Wikimedia's Gerrit documentation for new user interface in Gerrit 2.14 to Update Wikimedia's Gerrit documentation for new user interface in Gerrit 2.15.Jun 9 2018, 1:14 PM
Paladox updated the task description. (Show Details)

The WIP documentation for polygerrit needs documenting as this would have resolved T197238 (IE the "Start Review" button is the unwip button)

This task will get harder to fix once different users see different things when https://gerrit.wikimedia.org/r/#/c/439444/ gets merged for T196812

I updated Wikimedia's Gerrit documentation for the default user interface in 2.15.3:

So the default (new?) 2.15.3 UI should hopefully be covered in our docs now. That is what the task summary says. So I'd call this resolved. But the task description talks about polygerrit instead. I did not cover the polygerrit UI because that's not the default UI for users. The scope of this task is unclear to me.

I've updated some of the screenshots to have both the old ui and new ui.

polygerrit becomes default in 2.16 / 3.0 (done my me). Where as we will be setting the default ui on gerrit.wikimedia.org to polygerrit next monday.

Thanks for the edits!
The page now has four (?) additional screenshots that someone needs to maintain forever and update every time the user interface changes. Do really all screenshots add additional value to a new reader?

It also uses the word (?) "ui" several times without explaining what that is (abbreviations are usually written in upper case?), plus you don't "do a website". :)
Please imagine being a newcomer when editing docs which are for newcomers.
Thank you a lot! :)

the old ui screen shots can be removed when ever upstream removes it (and we update to that version) :).

What about the other screenshots and their usefulness? What about "ui"?

Well for starters having just screenshots of the old ui and none for the new ui. Will confuse a new user more.

Now i am not qualified to tell what new users will understand. Though fill free to change any of the writing i did to words that new users will understand.

I just thought i add screenshots of the new ui. But i guess it was wrong for me to do that?

Nah, not wrong. I only now realized that all those screenshots unfortunately already existed, sorry! :P Made edits in https://www.mediawiki.org/w/index.php?title=Gerrit%2FTutorial&type=revision&diff=2847677&oldid=2847655 and removed unexplained acronyms etc. :)

Aklapper renamed this task from Update Wikimedia's Gerrit documentation for new user interface in Gerrit 2.15 to Update Wikimedia's Gerrit documentation for new UI (GWTUI to be superseded by polygerrit).Mar 20 2019, 11:10 AM

@Paladox: Wondering whether to merge this into my duplicate (sorry!) at T227562: Update Gerrit documentation on user interface for Gerrit 3.2 on mediawiki.org? Or the other way round (but need to update task dependencies in that case)?