Fix some typos and correct formatting in the README file

Change-Id: Ib97cbe15fe8c4a2126a1d56509bc9295627698cd
This commit is contained in:
Christian Berendt 2014-08-15 16:53:34 +02:00
parent 70918715bf
commit 121c209aa3
1 changed files with 14 additions and 14 deletions

View File

@ -1,13 +1,13 @@
========================== ========================
Gerrit Dashboard Creator Gerrit Dashboard Creator
========================== ========================
Creates custom urls for gerrit dashboards Creates custom URLs for Gerrit dashboards
The Problem The Problem
=========== ===========
The Gerrit Review system is great, until it gets completely out of The Gerrit code review system is great, until it gets completely out of
control with too much content in it. When you are staring at a single control with too much content in it. When you are staring at a single
list of 400 reviews, it's completely overwhelming. list of 400 reviews, it's completely overwhelming.
@ -20,31 +20,31 @@ I've found that slicing up the giant review task into a set of smaller
buckets that you can see actually get smaller as you go through them buckets that you can see actually get smaller as you go through them
becomes a far more motivating way of looking at reviews. becomes a far more motivating way of looking at reviews.
As of gerrit 2.6 there is support for building custom dashboards, both As of Gerrit 2.6 there is support for building custom dashboards, both
on the server side, and on the client side (as a url). These are on the server side, and on the client side (as a URL). These are
really powerful. really powerful.
The server side defintion for these dashboards is pretty easy to The server side definition for these dashboards is pretty easy to
understand, however you need really extreme levels of permissions to understand, however you need really extreme levels of permissions to
create these dashboards. The client side definition is a single url create these dashboards. The client side definition is a single URL
which is hard to manipulate inline. which is hard to manipulate inline.
This tool takes the server side definition, creates the client side This tool takes the server side definition, creates the client side
encoding of it, and spits that url out on the command line. You can encoding of it, and spits that URL out on the command line. You can
then load it in your browser and off you go. then load it in your browser and off you go.
Usage Usage
===== =====
It's super easy, just check out the code, and pass it 1 arg, which is It's super easy, just check out the code, and pass 1 argument, which is
the dash file you want the url for:: the dashboard file you want the URL for::
> ./gerrit-dash-creator dashboards/devstack.dash > ./gerrit-dash-creator dashboards/devstack.dash
URL for Devstack Review Inbox URL for Devstack Review Inbox
https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack-dev%2Fdevstack+OR+project%3Aopenstack-dev%2Fdevstack-vagrant+OR+project%3Aopenstack-dev%2Fbashate+OR+project%3Aopenstack-dev%2Fgrenade%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D-1+label%3AVerified%3E%3D1%252cjenkins+NOT+label%3ACode-Review%3E%3D0%252cself&title=Devstack+Review+Inbox&&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode-Review%3C%3D2+age%3A5d&Your+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode-Review%3C%3D2%2Cself+reviewer%3Aself&Needs+final+%2B2=label%3ACode-Review%3E%3D2+limit%3A50+NOT+label%3ACode-Review%3C%3D-1%2Cself&Passed+Jenkins%2C+No+Negative+Feedback=NOT+label%3ACode-Review%3E%3D2+NOT+label%3ACode-Review%3C%3D-1+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode-Review%3C%3D2+age%3A2d https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack-dev%2Fdevstack+OR+project%3Aopenstack-dev%2Fdevstack-vagrant+OR+project%3Aopenstack-dev%2Fbashate+OR+project%3Aopenstack-dev%2Fgrenade%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D-1+label%3AVerified%3E%3D1%252cjenkins+NOT+label%3ACode-Review%3E%3D0%252cself&title=Devstack+Review+Inbox&&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode-Review%3C%3D2+age%3A5d&Your+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode-Review%3C%3D2%2Cself+reviewer%3Aself&Needs+final+%2B2=label%3ACode-Review%3E%3D2+limit%3A50+NOT+label%3ACode-Review%3C%3D-1%2Cself&Passed+Jenkins%2C+No+Negative+Feedback=NOT+label%3ACode-Review%3E%3D2+NOT+label%3ACode-Review%3C%3D-1+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode-Review%3C%3D2+age%3A2d
Then put the url in your browser and off you go. Then put the URL in your browser and off you go.
Contributions Welcomed Contributions Welcomed
====================== ======================
@ -56,7 +56,7 @@ current outstanding changes can be seen at:
https://review.openstack.org/#/q/status:open+project:stackforge/gerrit-dash-creator,n,z https://review.openstack.org/#/q/status:open+project:stackforge/gerrit-dash-creator,n,z
I'm very happy to include additional interesting examples that teams I'm very happy to include additional interesting examples that teams
fine useful, and make it possible for teams to explore other find useful, and make it possible for teams to explore other
approaches to reviewing code. approaches to reviewing code.
If you have questions please find me on #openstack-dev, If you have questions please find me on #openstack-dev,