Skip to content

Commit 4c6bf28

Browse files
p-mongop
andauthored
Document staging (#2)
Co-authored-by: Oleg Pudeyev <[email protected]>
1 parent 2e687aa commit 4c6bf28

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff 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
2626
binaries 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+
2852
Contribute
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+
3159
To contribute to the documentation, please sign the `MongoDB
3260
Contributor Agreement
3361
<https://www.mongodb.com/legal/contributor-agreement>`_ if you have not

0 commit comments

Comments
 (0)