File tree Expand file tree Collapse file tree 1 file changed +28
-0
lines changed Expand file tree Collapse file tree 1 file changed +28
-0
lines changed Original file line number Diff line number Diff line change @@ -25,9 +25,37 @@ The generated HTML will be placed in `build/master/html/`.
2525*Note *: The build process invokes Sphinx and expects Sphinx's various
2626binaries to be in PATH.
2727
28+ Stage
29+ -----
30+
31+ Install [mut](https://github.com/mongodb/mut) following its installation
32+ instructions.
33+
34+ Request access to the documentation staging bucket. Obtain AWS S3
35+ access key id and secret access key.
36+
37+ Create ``~/.config/giza-aws-authentication.conf `` with the following contents::
38+
39+ [authentication]
40+ accesskey=<AWS access key>
41+ secretkey=<AWS secret key>
42+
43+ (If you run ``make stage `` without configuring authentication, it will
44+ also give you these instructions.)
45+
46+ Finally to publish the docs to the staging bucket, run::
47+
48+ make stage
49+
50+ The output will include a URL to the published documentation.
51+
2852Contribute
2953----------
3054
55+ Documentation sources for Mongoid are in Mongoid's primary repository:
56+ https://github.com/mongodb/mongoid/tree/master/docs/tutorials.
57+ This repository contains documentation build tooling only.
58+
3159To contribute to the documentation, please sign the `MongoDB
3260Contributor Agreement
3361<https://www.mongodb.com/legal/contributor-agreement> `_ if you have not
You can’t perform that action at this time.
0 commit comments