summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorMark Côté <mcote@alumni.uwaterloo.ca>2017-06-07 15:06:02 +0200
committerDylan William Hardison <dylan@hardison.net>2017-06-07 15:06:02 +0200
commit8a4dbd5cca23762df61f767473aa92d87167895b (patch)
tree63152abdcdb62a083bedf7b158d0f5136d53d464 /README.rst
parentf02c8bd226d332f6d0ef7d8c55fbace94c055d20 (diff)
downloadbugzilla-8a4dbd5cca23762df61f767473aa92d87167895b.tar.gz
bugzilla-8a4dbd5cca23762df61f767473aa92d87167895b.tar.xz
Fix and improve wording in README.rst. (#93)
This fixes a number of typos, formatting errors, and awkward phrasings.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst48
1 files changed, 25 insertions, 23 deletions
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 <https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_file_loc=http%3A%2F%2F&bug_ignored=0&bug_severity=normal&bug_status=NEW&cf_fx_iteration=---&cf_fx_points=---&component=Developer%20Box&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&defined_groups=1&flag_type-254=X&flag_type-4=X&flag_type-607=X&flag_type-791=X&flag_type-800=X&flag_type-803=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=bugzilla.mozilla.org&rep_platform=Unspecified&target_milestone=---&version=Production>`__
+If this fails, please file a bug `using this link <https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_file_loc=http%3A%2F%2F&bug_ignored=0&bug_severity=normal&bug_status=NEW&cf_fx_iteration=---&cf_fx_points=---&component=Developer%20Box&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&defined_groups=1&flag_type-254=X&flag_type-4=X&flag_type-607=X&flag_type-791=X&flag_type-800=X&flag_type-803=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=bugzilla.mozilla.org&rep_platform=Unspecified&target_milestone=---&version=Production>`__.
-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.