Skip to content

Commit 447d434

Browse files
committed
Updated local setup steps.
1 parent b6368a1 commit 447d434

File tree

1 file changed

+40
-3
lines changed

1 file changed

+40
-3
lines changed

CONTRIBUTING.md

+40-3
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ consensus around project direction and issue solutions within issue threads
1818

1919
Please note the following:
2020

21-
* Pull Requests to the plugin-docs repository will be rejected; please file an issue for incorrect documentation instead. This is because we need to ensure that the issue is corrected in the internal source code.
22-
* Pull Requests to the plugin-samples repository and other repositories in the AdobeXD organization are welcome. Please file an issue first so that your contribution can be discussed.
21+
- Pull Requests to the plugin-docs repository will be rejected; please file an issue for incorrect documentation instead. This is because we need to ensure that the issue is corrected in the internal source code.
22+
- Pull Requests to the plugin-samples repository and other repositories in the AdobeXD organization are welcome. Please file an issue first so that your contribution can be discussed.
2323

2424
## Contributor License Agreement
2525

@@ -35,6 +35,8 @@ Security issues shouldn't be reported on this issue tracker. Instead, [file an i
3535

3636
## Viewing Docs Locally
3737

38+
### Setup
39+
3840
To preview the fully formatted docs as they will appear online, follow these steps:
3941

4042
```bash
@@ -51,4 +53,39 @@ python -m SimpleHTTPServer 8000
5153
# ...then open http://localhost:8000
5254
```
5355

54-
Testing this way is important since formatting that looks fine in your Markdown viewer of choice may be interpreted differently by Gitbook's HTML generator.
56+
### Preparing to push changes
57+
58+
When you're done making changes:
59+
60+
```bash
61+
# Rebuild HTML content
62+
npm run book:build
63+
64+
# Check for 404s
65+
npm run test:404 # See notes below about this
66+
67+
# Push to GitHub
68+
git push
69+
```
70+
71+
From there, submit your pull request.
72+
73+
### Checking for 404s locally
74+
75+
When you run `npm run book:build`, you'll wait for a bit as the script scans the site, and then get a report of any found 404s in your terminal. Detailed logs will be dumped to `./.logs/log.txt`.
76+
77+
Generally you can safely ignore these 404s:
78+
79+
- `/plugin-docs/images/xd-logo.png` (due to the way the repo is structured, this image will only appear on the published site)
80+
- `console.adobe.io` links (because the script isn't logged in, it gets a 404 from the Console)
81+
- `ngrok` links (used in code samples; not expected to function as links)
82+
83+
### Publishing
84+
85+
If you're an Adobe person, when you're ready to publish the changes, run:
86+
87+
```bash
88+
npm run book:publish:github
89+
```
90+
91+
The changes will appear in bit!

0 commit comments

Comments
 (0)