Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Grammar, cleanup, links, and formatting
Responding to review in #2299
  • Loading branch information
willbarton committed Aug 11, 2016
1 parent 16cba53 commit c46ef17
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -24,10 +24,10 @@ guidance below.
## Changing the codebase

If you are a contributor from outside of CFPB, you should fork this
repository, make changes in your own fork, and then submit a pull-request.
repository, make changes in your own fork, and then submit a pull request.

If you are a contributor within CFPB, you may also fork, or follow our
[documentation for branching](http://cfpb.github.io/cfgov-refresh/branching-merging/).
[documentation for branching](https://cfpb.github.io/cfgov-refresh/branching-merging/).

For timely code reviews of pull requests, please tag @cfpb/cfgov-backends and
@cfpb/cfgov-frontends as appropriate for your changes.
Expand Down
2 changes: 1 addition & 1 deletion INSTALL.md
@@ -1,4 +1,4 @@
# Installation and Configuration for cfgov-refresh

Please see [docs/installation.md](docs/installation.md) or our [online
installation instructions](http://cfpb.github.io/cfgov-refresh/installation/).
installation instructions](https://cfpb.github.io/cfgov-refresh/installation/).
14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -13,15 +13,15 @@ and [Wagtail CMS](https://wagtail.io) for content administration.

## Quickstart

Full [installation](http://cfpb.github.io/cfgov-refresh/installation/)
and [usage](http://cfpb.github.io/cfgov-refresh/usage/) instructions
are available in [our documentation](http://cfpb.github.io/cfgov-refresh).
Full [installation](https://cfpb.github.io/cfgov-refresh/installation/)
and [usage](https://cfpb.github.io/cfgov-refresh/usage/) instructions
are available in [our documentation](https://cfpb.github.io/cfgov-refresh).

Ensure that Elasticsearch and MySQL are installed and that MySQL is
either runable by our [backend.sh script](https://github.com/cfpb/cfgov-refresh/blob/master/backend.sh#L41) and our [runserver.sh script](https://github.com/cfpb/cfgov-refresh/blob/master/runserver.sh#L12).
either runnable by our [backend.sh script](https://github.com/cfpb/cfgov-refresh/blob/master/backend.sh#L41) and our [runserver.sh script](https://github.com/cfpb/cfgov-refresh/blob/master/runserver.sh#L12).

```
git clone https://github.com/cfpb/cfgov-refresh.git
git clone git@github.com:cfpb/cfgov-refresh.git
cd cfgov-refresh
pip install virtualenv virtualenvwrapper
npm install -g gulp bower
Expand All @@ -34,13 +34,13 @@ source setup.sh
## Documentation

Documentation for this project is available in the [docs](docs/) directory
and online: http://cfpb.github.io/cfgov-refresh/
and [online](https://cfpb.github.io/cfgov-refresh/).

If you would like to browse the documentation locally, you can do so
with `mkdocs`:

```
git clone https://github.com/cfpb/cfgov-refresh.git
git clone git@github.com:cfpb/cfgov-refresh.git
cd cfgov-refresh
pip install virtualenv virtualenvwrapper
source activate-virtualenv.sh
Expand Down
2 changes: 1 addition & 1 deletion TEST.md
@@ -1,4 +1,4 @@
# Testing

Please see [docs/testing.md](docs/testing.md) or our [online
testing instructions](http://cfpb.github.io/cfgov-refresh/testing/).
testing instructions](https://cfpb.github.io/cfgov-refresh/testing/).
2 changes: 1 addition & 1 deletion docs/branching-merging.md
Expand Up @@ -4,7 +4,7 @@ Branches should be named descriptively, preferably in some way that indicates wh

All pull requests to merge into master must be reviewed by at least one member of the cf.gov platform team. The cf.gov platform team will ensure that these reviews happen in a timely manner. To ensure timely code reviews, please tag all PRs to master with @cfpb/cfgov-backends and @cfpb/cfgov-frontends as appropriate.

When reviewing pull requests, it is important to distinguish between explicit blockers and things that can be addressed later or would be nice to have. This is best as a simple top-level post after review to summarize the review.
When reviewing pull requests, it is important to distinguish between explicit blockers and things that can be addressed in the future or would be nice to have. The later two can be indicated with 'TODO'. This is best as a simple top-level post after review to summarize the review.

The cfgov-refresh repository makes use of automated testing and linting to ensure the quality, consistency, and readability of the codebase. All pull requests to master must pass all automated tests and must not reduce the code coverage of the codebase. It is the responsibility of the submitter to ensure that the tests pass.

Expand Down
12 changes: 6 additions & 6 deletions docs/installation.md
Expand Up @@ -5,7 +5,7 @@
Using the console, navigate to the root directory in which your projects live and clone this project's repository:

```bash
git clone https://github.com/cfpb/cfgov-refresh.git
git clone git@github.com:cfpb/cfgov-refresh.git
cd cfgov-refresh
```

Expand All @@ -25,9 +25,9 @@ These instructions are somewhat specific to developing on Mac OS X,
but if you're familiar with other Unix-based systems,
it should be fairly easy to adapt them to your needs.

### Install system-level requirements ##
### Install system-level requirements

#### virtualenv & virtualenvwrapper Python modules ####
#### virtualenv & virtualenvwrapper Python modules

Install [virtualenv](https://virtualenv.pypa.io/en/latest/index.html)
and [virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/)
Expand All @@ -37,7 +37,7 @@ to be able to create a local environment for your server:
pip install virtualenv virtualenvwrapper
```

#### Autoenv module ####
#### Autoenv module

This project uses a large number of environment variables.

Expand Down Expand Up @@ -145,7 +145,7 @@ npm install -g gulp bower
This project requires Node.js v5.5 or higher, and npm v3 or higher.


#### Set up your environment ####
#### Set up your environment

If this is the first time you're setting up the project, run the following
script to copy `.env_SAMPLE` to `.env`, export your environment variables,
Expand All @@ -163,7 +163,7 @@ If you setup Autoenv earlier, this will happen for you automatically when you
If you prefer not to use Autoenv, just be sure to `source .env` every time
you start a new session of work on the project.

#### Run `setup.sh` ####
#### Run `setup.sh`

At this point, your machine should have everything it needs to automate the
rest of the setup process.
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
@@ -1,6 +1,6 @@
# Introduction

This is the documentation for the `cfgov-refresh` project, a redesign of the [www.consumerfinance.gov](http://www.consumerfinance.gov) website. It is organized thematically in order to create a central repository for all knowledge and information pertaining to cfgov-refresh.
This is the documentation for the `cfgov-refresh` project, a redesign of the [www.consumerfinance.gov](http://www.consumerfinance.gov) website. It is organized thematically in order to create a central repository for all information pertaining to cfgov-refresh.

# Disclaimer

Expand Down

0 comments on commit c46ef17

Please sign in to comment.