Commit77332f9

committed

Mention docker-compose first in the README

1 parent42296ff commit77332f9Copy full SHA for 77332f9

File tree

-6

lines changed

-6

lines changed

Lines changed: 7 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,16 +6,18 @@ This site is built with Jekyll. Documentation content is written in Markdown for`
`6`	`6`	`##Deploying`
`7`	`7`	The site is automatically deployed when commits are merged/pushed in`master`, hosted athttps://codefresh.io/docs/
`8`	`8`
`9`		`-###Running documentation locally`
	`9`	`+###Preview documentation locally with Docker (Recommended)`
	`10`	`+`
	`11`	`+1. Install[docker-compose](https://docs.docker.com/compose/)`
	`12`	+2. Run`docker-compose up`
	`13`	+3. Open`http://localhost:3131` in your browser, and voila!
	`14`	`+`
	`15`	`+###Preview documentation locally (Legacy method)`
`10`	`16`
`11`	`17`	1. Install Ruby,`bundler`,`jekyll` and other Ruby dependencies with`bundle install`.
`12`	`18`	2. Run`npm install` to install Node.js dependencies.
`13`	`19`	3. Run`npm run css` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
`14`	`20`	4. From the root directory, run`npm run docs-serve-dev` in the command line.
`15`	`21`	5. Open`http://localhost:19002` in your browser, and voila.
`16`	`22`
`17`		`-###Running documentation locally with Docker`
`18`	`23`
`19`		`-1. Install[docker-compose](https://docs.docker.com/compose/)`
`20`		-2. Run`docker-compose up`
`21`		-3. Open`http://localhost:3131` in your browser, and voila!

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ The minimum permissions for the token are:`
`104`	`104`	-`admin:repo_hook.*`
`105`	`105`	-`admin:org.*`
`106`	`106`
`107`		`->The admin permission for the org is required to allow the addition ofwebhhoks on org projects.`
	`107`	`+>The admin permission for the org is required to allow the addition ofwebhooks on org projects.`
`108`	`108`
`109`	`109`	`{% include image.html`
`110`	`110`	`lightbox="true"`

Comments

(0)