gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add more details to Debugging section (#5814)

Browse Source 
- Add more concrete instruction for configuring backend
- Explain what users should look for when changing `dev-test/index.html`
- Add more info to use local storage to set Netlify site's URL
This commit is contained in:
Trang Le 2021-09-29 18:34:29 +07:00 committed by GitHub
parent 555f71b2e0
commit b611636041
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -146,7 +146,13 @@ Netlify CMS uses the [Forking Workflow](https://www.atlassian.com/git/tutorials/
`yarn start` spawns a development server and uses `dev-test/config.yml` and `dev-test/index.html` to serve the CMS. `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: In order to debug a specific issue follow the next steps:
1. Replace `dev-test/config.yml` with the relevant `config.yml` 1. Replace `dev-test/config.yml` with the relevant `config.yml`. If you want to test the backend, make sure that the `backend` property of the config indicates which backend you use (Github, Gitlab, Bitbucket etc) and path to the repo.
```js
backend:
name: github
repo: owner-name/repo-name
```
2. Change the content of `dev-test/index.html` to: 2. Change the content of `dev-test/index.html` to:
@ -166,6 +172,7 @@ In order to debug a specific issue follow the next steps:
</body> </body>
</html> </html>
``` ```
The most important thing is to make sure that Netlify CMS is loaded from the `dist` folder. This way, every time you make changes to the source code, they will be compiled and reflected immediately on `localhost`.
3. Run `yarn start` 3. Run `yarn start`
4. Open `http://localhost:8080/` in the browser and you should have access to the CMS 4. Open `http://localhost:8080/` in the browser and you should have access to the CMS
@ -178,7 +185,7 @@ When debugging the CMS with Git Gateway you must:
2. Tell the CMS the URL of your Netlify site using a local storage item. To do so: 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 1. Open `http://localhost:8080/` in the browser
2. Write the below command and press enter: `localStorage.setItem('netlifySiteURL', 'https://yourwebsiteurl.netlify.app/')` 2. Open the Developer Console. 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')` 3. To be sure, you can run this command as well: `localStorage.getItem('netlifySiteURL')`
4. Refresh the page 4. Refresh the page
5. You should be able to log in via your Netlify Identity email/password 5. You should be able to log in via your Netlify Identity email/password