From aa383536273ff5b2c5d07d190560b54fb75943ae Mon Sep 17 00:00:00 2001 From: Soon Van Date: Thu, 12 Apr 2012 23:14:14 -0400 Subject: [PATCH] casing proper nouns; javascripts sounds odd; intro heading on intro is redundant --- _sources/appendices/config_files.txt | 2 +- _sources/design/dev-instance.txt | 12 ++++++------ _sources/design/feature-flags.txt | 6 +++--- _sources/dev/index.txt | 21 +++++++++------------ 4 files changed, 19 insertions(+), 22 deletions(-) diff --git a/_sources/appendices/config_files.txt b/_sources/appendices/config_files.txt index 06f8945..50231ec 100644 --- a/_sources/appendices/config_files.txt +++ b/_sources/appendices/config_files.txt @@ -2,5 +2,5 @@ Configuration files ===================== -List of all the relevant config files, their syntaxes and what the control. +List of all the relevant config files, their syntaxes and what they control. diff --git a/_sources/design/dev-instance.txt b/_sources/design/dev-instance.txt index 6a2b1f3..4d306c0 100644 --- a/_sources/design/dev-instance.txt +++ b/_sources/design/dev-instance.txt @@ -7,8 +7,8 @@ Installing Dependencies Installing CouchDB ^^^^^^^^^^^^^^^^^^ -On Linux, installing CouchDB involves installing so many dependencies, some of -them are incompatible with ubuntu/debian installations. Fortunately, a binary +On Linux, installing CouchDB involves installing many dependencies, some of +them are incompatible with Ubuntu/Debian installations. Fortunately, a binary distribution with all the binaries is provided by CouchOne. http://www.couchone.com/get @@ -22,15 +22,15 @@ updates the path in some scripts and config files. The created bundle ``couchdb-1.0.1-linux-binaries.tgz`` is uploaded to http://www.archive.org/details/ol_vendor. -On Max OS X, installing couchdb is somewhat easier than installing on Linux. -However to make the installations on both mac and linux similar, binaries are taken from +On Max OS X, installing CouchDB is somewhat easier than installing on Linux. +However, to make the installations on both Mac and Linux similar, binaries are taken from `CouchDBX`_ app. Unlike Linux, where ``bin`` and ``etc`` are available in the top-level, mac binaries have them at 2 level deep. To make both distributions identical, a ``bin/couchdb`` script is added and ``etc`` is symlinked from -``couchdb_1.0.1/etc``. Also the mac couchdb script expects the base directory -should be the working directory. The above ``bin/couchdb`` script, takes of +``couchdb_1.0.1/etc``. Also, the Mac CouchDB script expects the base directory +to be the working directory. The above ``bin/couchdb`` script takes care of this too. .. _CouchDBX: http://dl.couchone.com/dl/26f246a0fe23d6a53d532671330bf06d/CouchDBX-1.0.1.1.zip diff --git a/_sources/design/feature-flags.txt b/_sources/design/feature-flags.txt index aa301d7..e57800b 100644 --- a/_sources/design/feature-flags.txt +++ b/_sources/design/feature-flags.txt @@ -3,7 +3,7 @@ Feature Flags Feature flags is a way to have features under development live on production and visible only to admins/beta-users. -The idea of Feature Flags came from Flicker. They manage their development on a single branch using feature flags. +The idea of Feature Flags came from Flickr. They manage their development on a single branch using feature flags. http://code.flickr.com/blog/2009/12/02/flipping-out/ @@ -19,7 +19,7 @@ To make some part of the template visible only if a feature-flag is enabled:: $for list in page.get_lists(): ... -To enable a url only if a feature flag is enabled:: +To enable a URL only if a feature flag is enabled:: class home(delegate.page): path = "/" @@ -44,7 +44,7 @@ In Open Library, the feature flags are specified in the ``openlibrary.yml`` file usergroup: beta-users The value of a feature flag is called a *filter*. A filter can be specified either as its name or as a dict containing its name and parameters. -For example, the following 2 example mean the same. :: +For example, the following two examples mean the same. :: features: lists: admin diff --git a/_sources/dev/index.txt b/_sources/dev/index.txt index cfe62b0..3d8789f 100644 --- a/_sources/dev/index.txt +++ b/_sources/dev/index.txt @@ -4,21 +4,18 @@ Getting Started with Development Working with JavaScript ----------------------- -Introduction -~~~~~~~~~~~~ - The Open Library website makes heavy use of jQuery libraries. -Except ``jquery`` and ``jquery-ui``, all other third-party javascript libraries are combined and included as ``vendor.js``. +Except ``jquery`` and ``jquery-ui``, all other third-party JavaScript libraries are combined and included as ``vendor.js``. -All the custom javascripts are combined and includes as ``all.js``. +All the custom JavaScript is combined and included as ``all.js``. vendor.js and third party libraries ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -All third-party javascripts are added in the `vendor/js`_ directory in the +All third-party JavaScript files are added in the `vendor/js`_ directory in the repository and ``static/build/vendor.js`` is generated by combining these -javascripts. The files included in ``static/build/vendor.js`` are specified in +JavaScript files. The files included in ``static/build/vendor.js`` are specified in a shell script ``static/js/vendor.jsh``. To include a new third-party library: @@ -34,17 +31,17 @@ To include a new third-party library: .. _vendor/js: http://github.com/openlibrary/openlibrary/tree/master/vendor/js .. _static/js/vendor.jsh: http://github.com/openlibrary/openlibrary/tree/master/static/upstream/js/vendor.jsh -all.js and custom javascripts +all.js and custom JavaScript ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -All the custom javascript files are put in the repo at ``openlibrary/plugins/openlibrary/js``. -All these javascript files are combined to generate ``build/js/all.js``. +All the custom JavaScript files are put in the repo at ``openlibrary/plugins/openlibrary/js``. +All these JavaScript files are combined to generate ``build/js/all.js``. The order in which these files are included is determined by the sort order of the names. In general, it is a bad idea to depend on the order of files loaded. -If you make any changes to any of the javascript files, run ``make js`` to regenerate ``build/js/all.js``. +If you make any changes to any of the JavaScript files, run ``make js`` to regenerate ``build/js/all.js``. Working with CSS ---------------- @@ -54,4 +51,4 @@ All these stylesheets are combined to generate ``build/css/all.css``, which is i It is a good idea to break the css into multiple logical files instead of putting it in one monolithic file. -If you make any changes to any of the css files, run ``make css`` to regenerate ``build/css/all.css``. +If you make any changes to any of the CSS files, run ``make css`` to regenerate ``build/css/all.css``.