diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afc66924..7e626a7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,20 +7,17 @@ For details on contributing to documentation, see [Website Directory Readme](htt ## Setup -> Install Node.js (LTS) on your system: [https://nodejs.org/](https://nodejs.org/) - -> Install yarn on your system: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install) +> Install [Node.js (LTS)](https://nodejs.org/) and [yarn](https://yarnpkg.com/en/docs/install) on your system. ### Install dependencies -> Only required on the first run, subsequent runs can use `yarn start` to both -> bootstrap and run the development server. +> Only required on the first run, subsequent runs can use `yarn start` to both bootstrap and run the development server. ```sh -$ git clone https://github.com/netlify/netlify-cms -$ cd netlify-cms -$ yarn -$ yarn bootstrap +git clone https://github.com/netlify/netlify-cms +cd netlify-cms +yarn +yarn bootstrap ``` ### Run locally @@ -144,6 +141,48 @@ Netlify CMS uses the [Forking Workflow](https://www.atlassian.com/git/tutorials/ 7. PR's must be rebased before merge (feel free to ask for help). 8. PR should be reviewed by two maintainers prior to merging. +## Debugging + +`yarn start` spawns a development server and uses `dev-test/config.yml` and `dev-test/index.html` to serve the CMS. +In order to debug a specific issue follow the next steps: + +1. Replace `dev-test/config.yml` with the relevant `config.yml` + +2. Change the content of `dev-test/index.html` to: + +```html + + + + + Netlify CMS + + + + + + +``` + +3. Run `yarn start` +4. Open `http://localhost:8080/` in the browser and you should have access to the CMS + +### Debugging Git Gateway + +When debugging the CMS with Git Gateway you must: + +1. Have a Netlify site with [Git Gateway](https://docs.netlify.com/visitor-access/git-gateway/) and [Netlify Identity](https://docs.netlify.com/visitor-access/identity/) enabled. An easy way to create such a site is to use a [template](https://www.netlifycms.org/docs/start-with-a-template/), for example the [Gatsby template](https://app.netlify.com/start/deploy?repository=https://github.com/AustinGreen/gatsby-starter-netlify-cms&stack=cms) +2. Tell the CMS the URL of your Netlify site using a local storage item. To do so: + + 1. Open `http://localhost:8080/` in the browser + 2. Write the below command and press enter: `localStorage.setItem('netlifySiteURL', 'https://yourwebsiteurl.netlify.app/')` + 3. To be sure, you can run this command as well: `localStorage.getItem('netlifySiteURL')` + 4. Refresh the page + 5. You should be able to log in via your Netlify Identity email/password + ## License By contributing to Netlify CMS, you agree that your contributions will be licensed