Skip to content

Commit

Permalink
More markdown tweaking.
Browse files Browse the repository at this point in the history
  • Loading branch information
orta committed Apr 22, 2017
1 parent 6aba0e4 commit e56c8c9
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
20 changes: 10 additions & 10 deletions docs/guides/getting_started.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ There are 5 steps involved in getting Danger running:
* Setting up [an access token for Danger](#setting-up-an-access-token) with that account.
* Setting up [Danger to run on your CI](#setting-up-danger-to-run-on-your-ci).

### Including Danger
## Including Danger

We recommend you install Danger via [Yarn][]. Though you can use the npm CLI.

##### Installation
### Installation

Adding the Danger module by `yarn run danger --dev`. This will add Danger as a `devDependency` and make the command `danger` available by running `yarn danger`.

Expand Down Expand Up @@ -50,27 +50,27 @@ In order to get the most out of Danger, we recommend giving her the ability to p

To get started, open [https://github.com](https://github.com) in a private browser session.

##### OSS Projects
### OSS Projects

Do not add the bot to your repo or to your organization.

##### Closed Source Projects
### Closed Source Projects

Add the bot to your repo or to your organization. The bot requires permission level "Write" to be able to set a PR's status. Note that you _should not_ re-use this bot for OSS projects.

### Setting up an Access Token
## Setting up an Access Token

[Here's the link][github_token], you should open this in the private session where you just created the new GitHub account. Again, the rights that you give to the token depend on the openness of your projects. You'll want to save this token for later, when you add a `DANGER_GITHUB_API_TOKEN` to your CI.

##### Tokens for OSS Projects
### Tokens for OSS Projects

We recommend giving the token the smallest scope possible. This means just `public_repo`, this scopes limits Danger's abilities to just writing comments on OSS projects. Because the token can be quite easily be extracted from the CI environment, this minimizes the chance for bad actors to cause chaos with it.

##### Tokens for Closed Source Projects
### Tokens for Closed Source Projects

We recommend giving access to the whole `repo` scope, and its children.

### Enterprise GitHub
## Enterprise GitHub

You can work with GitHub Enterprise by setting 2 environment variables:

Expand All @@ -84,7 +84,7 @@ DANGER_GITHUB_HOST=git.corp.evilcorp.com
DANGER_GITHUB_API_BASE_URL=https://git.corp.evilcorp.com/api/v3
```

### Continuous Integration
## Continuous Integration

Continuous Integration is the process of regularly running tests and generating metrics for a project. It is where you can ensure that the code you are submitting for review is passing on all of the tests. You commonly see this as green or red dots next to commits.

Expand All @@ -98,7 +98,7 @@ Danger is built to run as a part of this process, so you will need to have this
/ https://github.com/danger/danger/tree/master/lib/danger/ci_source
/ inline documentation, rather than from inside this page.

### Verify Installation
## Verify Installation

You should be able to verify that you have successfully integrated Danger by either re-building your CI or pushing your new commits.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/the_dangerfile.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ As the JavaScript library API is relatively limited, the Danger module includes

The CHANGELOG for Danger is kept entirely end-user focused, so if there is an aspect of the Dangerfule that you do not know, or looks confusing and there is nothing in the document - check the CHANGELOG. This is where we write-up why a change happened, and how it can affect Danger users.

###Examples
### Examples

If you'd like to work with some reference material, here are some examples in the wild.

Expand Down
8 changes: 4 additions & 4 deletions source/ci_source/providers/Jenkins.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ import { ensureEnvKeysExist, ensureEnvKeysAreInt } from "../ci_source_helpers"
* ### CI Setup
* Ah Jenkins, so many memories. So, if you're using Jenkins, you're hosting your own environment.
*
* #### GitHub
* ### GitHub
* You will want to be using the
* [GitHub pull request builder plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin)
* in order to ensure that you have the build environment set up for PR integration.
*
* With that set up, you can edit your job to add `yarn danger` at the build action.
*
* ##### Pipeline
* ### Pipeline
* If you're using [pipelines](https://jenkins.io/solutions/pipeline/) you should be using the
* [GitHub branch source plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+Branch+Source+Plugin) for easy setup and handling of PRs.
*
* After you've set up the plugin, add a `sh 'yarn danger'` line in your pipeline script and make sure that build PRs is enabled.
*
* ### Token Setup
* ## Token Setup
*
* #### GitHub
* ### GitHub
* As you own the machine, it's up to you to add the environment variable for the `DANGER_GITHUB_API_TOKEN`.
*/
export class Jenkins implements CISource {
Expand Down

0 comments on commit e56c8c9

Please sign in to comment.