Skip to content

Commit a2076af

Browse files
committed
reorganized and clarified readme
1 parent 9f22ace commit a2076af

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

+20-7
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,30 @@
1313
### Getting started
1414

1515
The toolkit is placed in the `docs/` folder along with a frozen copy of the
16-
[Vocabulary][vocabulary] stylesheets. By opening the
17-
[`docs/index.html`](docs/index.html) file, you should be able to visualize the
18-
platform toolkit page. The same index and associated files are served, as is,
19-
in the production and staging environments.
20-
21-
Everything pertaining to the previous toolkit and model platform material is
22-
placed in the `deprecated/` folder.
16+
[Vocabulary][vocabulary] stylesheets. The site is predominately
17+
sellf-contained. You should be able to see nearly accurate rendering by
18+
cloning this repository and opening `docs/index.html` in your browser.
2319

2420
[vocabulary]: https://github.com/creativecommons/vocabulary
2521

2622

23+
## Hosting and Deployment
24+
25+
The `docs/` folder is served by the production server. Simply `git pull` to
26+
update to the most recent version. The Creative Commons production and staging
27+
environments are managed using SaltStack (see the [`nginx.misc`][misc-steate]
28+
state for specifics).
29+
30+
[misc-state]: https://github.com/creativecommons/sre-salt-prime/blob/master/states/nginx/misc.sls
31+
32+
33+
## Historical Files
34+
35+
Everything pertaining to the previous toolkit and model platform material is
36+
placed in the `deprecated/` folder. This folder will eventually be deleted
37+
(though it will remain in the git history).
38+
39+
2740
### License
2841

2942

0 commit comments

Comments
 (0)