jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 09:57:42 -05:00
Code Issues Projects Releases Wiki Activity

Move files out of script/ (#45454)

Browse Source 
Co-authored-by: Peter Bengtsson <peterbe@github.com>
This commit is contained in:
Kevin Heis
2023-11-02 11:17:39 -07:00
committed by GitHub
parent 3ecf4082e3
commit 748d1e3e3d
86 changed files with 121 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
contributing/development.md
View File

@@ -38,7 +38,7 @@ In a matter of minutes, you will be ready to edit, preview and test your changes
### Using browser shortcuts
The [`script/bookmarklets`](../script/bookmarklets) directory contains some browser shortcuts that can help with reviewing GitHub documentation. See [`script/bookmarklets/README.md`](../script/bookmarklets/README.md) for details.
The [`src/bookmarklets`](../src/bookmarklets) directory contains some browser shortcuts that can help with reviewing GitHub documentation. See [`src/bookmarklets/README.md`](../src/bookmarklets/README.md) for details.
### Enabling different languages

16
contributing/troubleshooting.md
View File

@@ -27,35 +27,35 @@ If a staging deployment is pending for more than 5-10min, try the following:
2. If that doesn't work, trigger a new staging deployment by pushing an empty commit on the command line:
```
$ git commit --allow-empty -m 'empty commit to redeploy staging'
git commit --allow-empty -m 'empty commit to redeploy staging'
```
### CI stalled or stuck
:yellow_heart: If tests are stuck yellow for more than an hour, rerun CI by pushing an empty commit on the command line:
```
$ git commit --allow-empty -m 'empty commit to rerun CI'
git commit --allow-empty -m 'empty commit to rerun CI'
```
### Can't run the site locally
If you are running `script/server` and get a `Cannot find module` error, try:
If you are running `npm start` and get a `Cannot find module` error, try:
```
$ npm install
npm install
```
If that doesn't fix it, try:
```
$ rm -rf node_modules
$ npm install
rm -rf node_modules
npm install
```
### Failed staging deployment
Check out the branch and run the site locally:
```
$ script/server
npm start
```
Go to https://localhost:4000
@@ -77,7 +77,7 @@ make sure single quotes are properly escaped in the frontmatter. Also, check the
Check out the branch and run the site locally:
```
$ script/server
npm start
```
Go to whatever page is 500ing on staging on your local server: https://localhost:4000/page-with-error

2
contributing/working-in-docs-repository.md
View File

@@ -16,6 +16,4 @@ Here's some information that might be helpful while working on a Docs PR:
- [Liquid](/contributing/liquid-helpers.md) - We use liquid helpers to create different versions of our content.
- [Scripts](/script/README.md) - The scripts directory is the home for all of the scripts you can run locally.
- [Tests](/tests/README.md) - We use tests to ensure content will render correctly on the site. Tests run automatically in your PR, and sometimes it's also helpful to run them locally.