Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Commit 6f2fa2a

Browse files
committed
update CONTRIBUTING [skip ci]
1 parent a4459c6 commit 6f2fa2a

File tree

1 file changed

+5
-17
lines changed

1 file changed

+5
-17
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,14 @@ Running the head binary:
2222
- `npm publish`
2323
- Regenerate documentation (see below)
2424

25-
If there's a high chance of regression, please bump to 1.0.0 so that code using a semver ^ or ~ doesn't auto-upgrade anyone.
25+
If there's a high chance of regression, please bump to a new major version number
26+
so that code using a semver ^ or ~ doesn't auto-upgrade anyone.
2627

2728
For examples of previous releases see: https://github.com/mapbox/carto/issues/440
2829

2930
## Documentation
3031

3132
This repository contains auto-generated documentation of the content of Carto
32-
that's published on Mapbox.com.
33-
34-
git fetch origin gh-pages:gh-pages
35-
36-
Edit `_docs/package.json` to point to the head version of [mapnik-reference](https://github.com/mapnik/mapnik-reference).
37-
38-
cd _docs
39-
npm install
40-
node generate.js
41-
42-
Then run up a directory and run the testing server:
43-
44-
cd ../
45-
jekyll serve -p 4000
46-
47-
Test the new site at `localhost:4000/carto` and if things look good then git add your changes and push.
33+
that's published on readthedocs.io. You find the relevant files in the `docs`
34+
directory. Those files with the extension `rst` are the ones where you find
35+
the documentation sources in reStructuredText.

0 commit comments

Comments
 (0)