Skip to content

Commit 5d9e16d

Browse files
committed
Fix and tweak syntax
1 parent 879ed5b commit 5d9e16d

10 files changed

+50
-143
lines changed
Lines changed: 8 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
title: "Fork these repositories into your own GitHub account. +"
2-
stepnum: 1
1+
title: "Fork these repositories into your own GitHub account."
32
ref: fork-repos
43
content: |
5-
64
`This guide from GitHub <https://guides.github.com/activities/forking/>`_ covers the specifics.
75
86
- https://github.com/mongodb/docs
@@ -15,99 +13,66 @@ content: |
1513
- https://github.com/mongodb/docs-bi-connector
1614
---
1715
title: "Clone and prepare MongoDB Documentation Assets."
18-
stepnum: 2
1916
ref: clone-docs-assets
20-
pre: |
21-
2217
action:
2318
language: sh
2419
code: |
25-
git clone [email protected]:<yourid>/docs-assets.git
20+
git clone [email protected]:<yourid>/docs-assets.git
2621
cd docs-assets
2722
git remote add upstream [email protected]:mongodb/docs-assets.git
2823
---
2924
title: "Clone and prepare MongoDB Documentation Toolset."
30-
stepnum: 3
3125
ref: prep-docs-tools
32-
pre: |
33-
3426
action:
3527
language: sh
3628
code: |
37-
git clone [email protected]:<yourid>/docs-tools.git
29+
git clone [email protected]:<yourid>/docs-tools.git
3830
cd docs-tools
3931
git remote add upstream [email protected]:mongodb/docs-tools.git
4032
---
4133
title: "Clone and prepare MongoDB Manual documentation."
42-
stepnum: 4
4334
ref: clone-docs
44-
pre: |
45-
4635
action:
4736
language: sh
4837
code: |
49-
git clone [email protected]:<yourid>/docs.git
38+
git clone [email protected]:<yourid>/docs.git
5039
cd docs
5140
giza generate assets
5241
git remote add upstream [email protected]:mongodb/docs.git
5342
---
5443
title: "Clone and prepare MongoDB Primer documentation."
55-
stepnum: 5
5644
ref: clone-docs-primer
57-
pre: |
58-
5945
action:
6046
language: sh
6147
code: |
62-
git clone [email protected]:<yourid>/docs-primer.git
48+
git clone [email protected]:<yourid>/docs-primer.git
6349
cd docs-primer
6450
git remote add upstream [email protected]:mongodb/docs-primer.git
6551
---
6652
title: "Clone and prepare the Cloud/Ops Manager documentation."
67-
stepnum: 6
6853
ref: clone-mms-docs
69-
pre: |
70-
7154
action:
7255
language: sh
7356
code: |
74-
git clone [email protected]:<yourid>/mms-docs.git
57+
git clone [email protected]:<yourid>/mms-docs.git
7558
cd mms-docs
7659
git remote add upstream [email protected]:10gen/mms-docs.git
7760
---
7861
title: "Clone and prepare the Atlas documentation."
79-
stepnum: 7
8062
ref: clone-cloud-docs
81-
pre: |
82-
8363
action:
8464
language: sh
8565
code: |
86-
git clone [email protected]:<yourid>/cloud-docs.git
66+
git clone [email protected]:<yourid>/cloud-docs.git
8767
cd cloud-docs
8868
git remote add upstream [email protected]:10gen/cloud-docs.git
8969
---
9070
title: "Clone and prepare the BI Connector documentation."
91-
stepnum: 8
9271
ref: clone-bi-docs
93-
pre: |
94-
9572
action:
9673
language: sh
9774
code: |
9875
git clone [email protected]:<yourid>/docs-bi-connector.git
9976
cd docs-bi-connector
10077
git remote add upstream [email protected]:10gen/docs-bi-connector.git
101-
---
102-
title: "If you want to be able to work from a local development copy of giza (optional):"
103-
stepnum: 9
104-
ref:
105-
pre: |
106-
107-
action:
108-
language: sh
109-
code: |
110-
sudo pip uninstall giza
111-
cd docs-tools/giza
112-
sudo python ./setup.py develop
113-
...
78+
...
Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
title: "Generate the certificate and follow the prompts. "
2-
stepnum: 1
32
ref: generate-certificates
43
pre: |
54
When you are asked to name the file, you must provide the full path as well.
@@ -8,44 +7,40 @@ pre: |
87
action:
98
language: sh
109
code: |
11-
ssh-keygen -t rsa -b 4096 -C "[email protected]"
10+
ssh-keygen -t rsa -b 4096 -C "[email protected]"
1211
---
1312
title: "Set the certificate permissions."
14-
stepnum: 2
1513
ref: set-cert-perms
1614
pre: |
1715
Change to the default user directory for SSH certificates. Change the
1816
permissions for the certificate to owner read/write only.
1917
action:
2018
language: sh
2119
code: |
22-
cd ~/.ssh/
20+
cd ~/.ssh/
2321
chmod 600 <name>.pub
2422
---
2523
title: "Enable SSH password management."
26-
stepnum: 3
2724
ref: enable-ssh-passwords
2825
pre: |
2926
This is supposed to be enabled by default on MacOS X systems.
3027
action:
3128
language: sh
3229
code: |
33-
eval ``ssh-agent``
30+
eval ``ssh-agent``
3431
---
3532
title: "Add your certificate to the SSH password manager."
36-
stepnum: 4
3733
ref: add-cert-to-ssh
3834
pre: |
3935
action:
4036
language: sh
4137
code: |
42-
ssh-add
38+
ssh-add
4339
post: "Enter the password for the certificate."
4440
---
4541
title: "Add this certificate to your GitHub account."
46-
stepnum: 5
4742
ref: add-cert-to-github
4843
content: |
4944
For specific instructions, see
5045
`GitHub <https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/>`_.
51-
...
46+
...
Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
title: "Login to your AWS Account."
2-
stepnum: 1
32
ref: login-aws
43
content: |
54
Login to `AWS for the Education department <https://idp.mongodb.com/simplesaml/saml2/idp/SSOService.php?spentityid=urn:amazon:webservices:univ-training-991734710418>`_.
65
76
---
87
title: "Connect to your AWS Instance."
9-
stepnum: 2
108
ref: connect-aws-instance
119
content: |
1210
@@ -18,7 +16,6 @@ content: |
1816
1917
---
2018
title: "Choose or create an SSH Key (if needed)."
21-
stepnum: 3
2219
ref: create-ssh-key
2320
content: |
2421
@@ -30,21 +27,19 @@ content: |
3027
3128
---
3229
title: "Copy this key file to your SSH certificate directory."
33-
stepnum: 4
3430
ref: copy-ssh-key
3531
pre: |
3632
action:
3733
language: sh
3834
code: |
39-
cp yourawscert.pem ~/.ssh/
35+
cp yourawscert.pem ~/.ssh/
4036
---
4137
title: "Change the ownership of this key file."
42-
stepnum: 5
4338
ref: update-key-permissions
4439
pre: |
4540
The key file must only be readable by you.
4641
action:
4742
language: sh
4843
code: |
49-
chmod 600 ~/.ssh/yourawscert.pem
50-
...
44+
chmod 600 ~/.ssh/yourawscert.pem
45+
...

source/includes/steps-install-aws-keys.yaml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
title: "Login to Cloud Manager."
2-
stepnum: 1
32
ref: login-cloud-manager-1
4-
53
---
64
title: "Set billing information."
7-
stepnum: 2
85
ref: set-billing
96
content: |
107
@@ -22,7 +19,6 @@ content: |
2219
2320
---
2421
title: "Complete the AWS Configuration."
25-
stepnum: 3
2622
ref: create-aws-config
2723
content: |
2824
@@ -63,7 +59,5 @@ content: |
6359
6460
---
6561
title: "Click :guilabel:`Add`."
66-
stepnum: 4
6762
ref: click-add
68-
69-
...
63+
...
Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
11
title: "Create a giza AWS configuration file in your home config directory."
2-
stepnum: 1
32
ref: create-aws-config
4-
pre: |
5-
63
action:
74
language: sh
85
code: |
96
mkdir -m 755 -p ~/.config
10-
vi ~/.config/giza-aws-authentication.conf
7+
vi ~/.config/giza-aws-authentication.conf
118
129
---
1310
title: "Add an ``[authentication]`` block in your configuration file."
14-
stepnum: 2
1511
ref: add-auth-block
16-
pre: |
17-
1812
action:
1913
language: ini
2014
code: |
@@ -27,17 +21,12 @@ action:
2721
2822
---
2923
title: "Save your configuration file."
30-
stepnum: 3
3124
ref: save-aws-config-file
32-
3325
---
3426
title: "Set this file to be owner readable."
35-
stepnum: 4
3627
ref: make-owner-readable
37-
pre: |
38-
3928
action:
4029
language: sh
4130
code: |
42-
chmod 600 ~/.config/giza-aws-authentication.conf
43-
...
31+
chmod 600 ~/.config/giza-aws-authentication.conf
32+
...

source/includes/steps-install-prereqs.yaml

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
title: "Download and Install XCode."
2-
stepnum: 1
32
ref: install-xcode
43
content: |
54
This is required for some development capabilities on a Mac OS system.
@@ -8,7 +7,6 @@ content: |
87
98
---
109
title: "Download and Install Inkscape."
11-
stepnum: 2
1210
ref: install-inkscape
1311
content: |
1412
@@ -19,14 +17,13 @@ content: |
1917
2018
---
2119
title: "Download and Install Homebrew."
22-
stepnum: 3
2320
ref: install-homebrew
2421
pre: |
2522
This is required to install certain development tools including MongoDB itself.
2623
action:
2724
language: sh
2825
code: |
29-
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
26+
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
3027
brew update
3128
brew doctor
3229
@@ -36,18 +33,14 @@ post: |
3633
More information on `Homebrew <http://brew.sh/>`_ can be found online.
3734
---
3835
title: "Install Python and Python 3."
39-
stepnum: 4
4036
ref: install-python
41-
pre: |
42-
4337
action:
4438
language: sh
4539
code: |
46-
brew install python
40+
brew install python
4741
brew install python3
4842
---
4943
title: "Install MongoDB Version Manager."
50-
stepnum: 5
5144
ref: install-m
5245
pre: |
5346
Install https://github.com/aheckmann/m[MongoDB Version Manager]
@@ -63,21 +56,17 @@ action:
6356
heading: "Install MongoDB Version Manager."
6457
language: sh
6558
code: |
66-
sudo npm install -g m
59+
sudo npm install -g m
6760
post: |
6861
.. note:: See https://github.com/aheckmann/m[MongoDB Version Manager] for more information on how to install versions of MongoDB.
6962
---
7063
title: "Install a specific version, edition or platform."
71-
stepnum: 6
7264
ref: install-mongodb
7365
content: |
7466
If you need a specific version, edition or platform of MongoDB, check the Private Build list for https://corp.10gen.com/dlBrowse?os=osx[OS X], https://corp.10gen.com/dlBrowse?os=linux[Linux] or https://corp.10gen.com/dlBrowse?os=win32[Windows].
7567
---
7668
title: "Install Documentation Building Tools."
77-
stepnum: 7
7869
ref: install-giza
79-
pre: |
80-
8170
action:
8271
heading: "Install Giza Pre-Requisites"
8372
language: sh
@@ -91,14 +80,14 @@ action:
9180
heading: "Install Giza."
9281
language: sh
9382
code: |
94-
sudo pip install giza
83+
sudo pip install giza
9584
9685
action:
9786
heading: "Install Mut."
9887
language: sh
9988
code: |
100-
bash -c "$(curl -fsSL https://raw.githubusercontent.com/i80and/mut/master/install.sh)"
89+
bash -c "$(curl -fsSL https://raw.githubusercontent.com/mongodb/mut/master/install.sh)"
10190
10291
post: |
10392
.. note:: More information on ``mut`` can be found on the https://docs-mongodbcom-staging.corp.mongodb.com/mut/tutorial/installation.html[mut guide].
104-
...
93+
...

0 commit comments

Comments
 (0)