Skip to content

Commit

Permalink
Fix markdown formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
c-w committed Dec 12, 2019
1 parent a8abfd8 commit d0250ca
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -27,7 +27,7 @@ The minor version usually means an ongoing development effort and there are thre

To make a change, you should **make a new feature branch** from the tip of the main branch of what you want to work on (mobile, new development or bug fixes). Doing this allows raising multiple pull requests at the same time if necessary. It is also a good way to keep productivity independent from the rate at which the pull requests are looked at

##Example of creating a separate branch for your feature or user story:
## Example of creating a separate branch for your feature or user story:

* Move to the correct branch. For example `git checkout maint_1.3`
* Create a new branch with an appropriate name (**also add a story number if there is one and a short description**) and switch to the branch
Expand All @@ -39,11 +39,11 @@ To make a change, you should **make a new feature branch** from the tip of the m
* After that you can checkout to master or create a new branch for the next feature or bug
* Also take a look at the excellent [OpenMRS guide to using git](https://wiki.openmrs.org/display/docs/Using+Git)

#Tests
# Tests

**Make sure all Rspec tests pass before making a pull request!!!** Currently the Cucumber feature tests are not used or maintained, but may be resurrected in the future to act as a smoke-test suite.


#Note about the Release Target
# Note about the Release Target

There is also a version file in the code itself in `config/version.rb` which is incremented that after a release. So for example if we just released v1.4.0.5, we increment it to v1.4.0.6
22 changes: 11 additions & 11 deletions cookbook/README.md
Expand Up @@ -26,15 +26,15 @@ Requirements

Checkout Primero repository
------------
###Make sure you have git installed
### Make sure you have git installed

####OSX
#### OSX
```sh
$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
$ brew install git
```

####Ubuntu
#### Ubuntu
```sh
$ sudo apt-get install git-core
```
Expand Down Expand Up @@ -78,15 +78,15 @@ Install Chef (local machine)
------------
Install ChefDK (which also contains Berkshelf) and Knife Solo on your local machine. ChefDK packages a Chef-specific distribution of Ruby, so there is no need to install Ruby locally.

####Ubuntu/Debian
#### Ubuntu/Debian
```sh
$ wget https://packages.chef.io/stable/debian/6/chefdk_0.9.0-1_amd64.deb
$ sudo dpkg -i chefdk_0.9.0-1_amd64.deb
$ chef verify
$ chef gem install knife-solo --version 0.4.3
```

####OSX
#### OSX
Download and install [ChefDK 0.9](https://downloads.chef.io/chef-dk/mac/) (he version is VERY IMPORTANT!)

```sh
Expand All @@ -101,7 +101,7 @@ If any of the gems fail to install, for instance you receive "Unable to resolve
Try manually installing that gem. ex. `chef gem install retryable -v 2.0`


###Node File
### Node File
After Chef is successfully installed on the local machine, you will need to create a Chef node configuration file.
A sample Primero node file (dev-node.json.sample) is in the root directory of the application.

Expand All @@ -117,7 +117,7 @@ for a reference to a more or less complete node file for Primero. You can put
the node file anywhere you like on your local machine.
Any vlaues defined in this node file override values defined in attributes/default.rb

####Attributes
#### Attributes
The following attributes are of special interest for configuration:

- `primero.server_hostname` (required): The DNS hostname of the server. The
Expand Down Expand Up @@ -255,14 +255,14 @@ file:
}
```

####Runlist
#### Runlist
Your run_list should be set as follows...

For a standard deploy: `[ "recipe[primero::default]" ]`

For a standard deploy with configuration: `[ "recipe[primero::default]", "recipe[primero::configuration]" ]`

####Example node file
#### Example node file
```javascript
{
"couch_db": {
Expand Down Expand Up @@ -366,7 +366,7 @@ sensitive data. If you must expose it in your firewall, restrict the source IP
to one that you control.


###Hosted Instances
### Hosted Instances
On hosted instance of Primero, there could be a wide variety of potential
firewall solutions available. If it is hosted on a cloud environment like AWS
or Azure, those services provide firewall configuration in the management
Expand All @@ -381,7 +381,7 @@ In order to allow remote access for support and deployments, SSH should be secur
configured and exposed (port **22** is the default). It is strongly recommended
to not allow password access for SSH, and to limit the permitted access servers.

###Roving Instances
### Roving Instances
The roving field instances of Primero have similar firewall/port requires to
the above, except that you will be using the Windows firewall combined with
Virtualbox's port forwarding settings. When you first installed Primero on
Expand Down
4 changes: 2 additions & 2 deletions doc/docker.md
Expand Up @@ -25,7 +25,7 @@ following volumes:
- `/etc/ssl/primero`: You need to place the CouchDB SSL cert/key in this volume with the name `couch.{crt,key}`
- `/etc/couchdb/local.d`: You can put additional Couch configuration in this volume

####Envvars
#### Envvars


- `COUCHDB_PASSWORD`: the admin password for the default `primero` user. (default: None)
Expand All @@ -37,7 +37,7 @@ This image includes everything except for CouchDB, namely Solr, the Couch change
watcher, Nginx and Passenger. It also runs all of these processes using
Supervisor.

####Envvars
#### Envvars

- `COUCHDB_PASSWORD`: the password for the couch admin user (default: None)
- `PRIMERO_VIRTUAL_HOST`: virtual host name for the app (e.g. `primero-qa.quoininc.com`) (default: None)
Expand Down
10 changes: 5 additions & 5 deletions doc/ssl.md
Expand Up @@ -8,19 +8,19 @@ Primero requires SSL to run. The following options for enabling SSL are availabl
- **Let's Encrypt:** This is a free, automated [certificate authority](https://letsencrypt.org) that is based on DNS validation. Primero Chef deployment includes support for automatically enabling and periodically renewing Let's Encrypt certificates. See the file `cookbook/README.md` for how to do this.


###Application SSL
### Application SSL
To get the application SSL cert, you must go through a recognized Certificate
Authority (CA) or a CA which is trusted by the browsers of the primary users
of this Primero deployment. It is currently not possible to run Primero
except through HTTPS, nor is it advisable to run any part of Primero except
under HTTPS.

###CouchDB SSL
### CouchDB SSL
The CouchDB SSL cert uses a private CA whose root certificate is distributed
automatically to all of the servers to verify communication. To generate a
new key and cert, follow the next steps.

####Initial Setup
#### Initial Setup
(All from [this site](https://jamielinux.com/articles/2013/08/act-as-your-own-certificate-authority/).)

To setup a new root Certificate Authority to sign CouchDB certs, you need to configure your machine as your own certificate authority (CA).
Expand Down Expand Up @@ -91,7 +91,7 @@ See example below.
See the openssl docs for more info on how to configure things.
[https://www.openssl.org/docs/](https://www.openssl.org/docs/)

######Example config.cnf
###### Example config.cnf

```sh
[req]
Expand Down Expand Up @@ -134,7 +134,7 @@ localityName_default = Boston
emailAddress_default = unknown@quoininc.com
```

####Creating and Signing New Certs
#### Creating and Signing New Certs
Firstly, copy the openssl configuration file

```sh
Expand Down

0 comments on commit d0250ca

Please sign in to comment.