From 8a4dbd5cca23762df61f767473aa92d87167895b Mon Sep 17 00:00:00 2001 From: Mark Côté Date: Wed, 7 Jun 2017 09:06:02 -0400 Subject: Fix and improve wording in README.rst. (#93) This fixes a number of typos, formatting errors, and awkward phrasings. --- README.rst | 48 +++++++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 23 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 8eb5d1761..b88477cdd 100644 --- a/README.rst +++ b/README.rst @@ -2,9 +2,10 @@ BMO: bugzilla.mozilla.org ========================= -BMO is a Mozilla's highly customized version of Bugzilla. +BMO is Mozilla's highly customized version of Bugzilla. -If you are looking to run bugzilla, you should see https://github.com/bugzilla/bugzilla. +If you are looking to run Bugzilla, you should see +https://github.com/bugzilla/bugzilla. If you want to contribute to BMO, you can fork this repo and get a local copy of BMO running in a few minutes. @@ -22,31 +23,31 @@ Doing this on OSX can be accomplished with homebrew: brew install vagrant -For Ubuntu 16.04: -download the vagrant .dpkg directly from https://vagrantup.com, -the one that ships with Ubuntu is too old. +For Ubuntu 16.04, download the vagrant .dpkg directly from +https://vagrantup.com. The one that ships with Ubuntu is too old. Setup Vagrant VMs ================= -From your BMO checkout run the following command +From your BMO checkout run the following command: .. code-block:: bash vagrant up -Depending on your machine, this will take a few minutes to much longer -depending on your internet connection speed and the speed of your computer. +Depending on the speed of your computer and your Internet connection, this +will take from a few minutes to much longer. -If this fails, please file a bug `using this link `__ +If this fails, please file a bug `using this link `__. -Otherwise, you should have a working bmo developer machine setup! +Otherwise, you should have a working BMO developer machine! -To test it, you'll want to add an entry to /etc/hosts -for bmo-web.vm pointing to 192.168.3.43 +To test it, you'll want to add an entry to /etc/hosts for bmo-web.vm pointing +to 192.168.3.43. After that, you should be able to visit http://bmo-web.vm/ from your browser. -You can login as vagrant@bmo-web.vm with the password "vagrant01!" (without quotes). +You can login as vagrant@bmo-web.vm with the password "vagrant01!" (without +quotes). Making Changes and Seeing them ============================== @@ -62,16 +63,17 @@ to see the changes applied to your vagrant VM. Technical Details ================= -This is a very complete but scaled-down version of production BMO. It is using -roughly the same RPMS (centos 6 vs. EL 6 in production) and the same perl -dependencies (via https://github.com/mozilla-bteam/carton-bundles). +This Vagrant environment is a very complete but scaled-down version of +production BMO. It uses roughly the same RPMs (from CentOS 6, versus RHEL 6 +in production) and the same perl dependencies (via +https://github.com/mozilla-bteam/carton-bundles). -It includes most of the products, groups, and users too (with the users having -their password reset as mentioned above). Email is disabled for all users, -however it is safe to enable email as the box is configured to send all email -to the 'vagrant' user on the web vm. +It includes a couple example products, some fake users, and some of BMO's +real groups. Email is disabled for all users; however, it is safe to enable +email as the box is configured to send all email to the 'vagrant' user on the +web vm. -Most of the cron jobs and the jobqueue daemon are running. The push connector -is not currently configured, nor is it configured to talk to Pulse. +Most of the cron jobs and the jobqueue daemon are running. It is also +configured to use memcached. -It is configured to use memcached as well. +The push connector is not currently configured, nor is the Pulse publisher. -- cgit v1.2.3-24-g4f1b