Skip to content

Commit e3fffa6

Browse files
kirbykkirbyk
authored
Merge pull request #9 from jdestefano-mongo/DOCSP-636
DOCSP-636 - Modified tag data model and logic. Tagged initial set of …
2 parents 7e65bf8 + f7258fb commit e3fffa6

File tree

90 files changed

+3006
-3282
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+3006
-3282
lines changed

‎README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,3 +99,51 @@ Use the following tutorial outline whenever possible:
9999
* Use hyperlinks to point readers to supplemental content that may not
100100
covered in entirety in the tutorial. This helps keep the tutorial
101101
focused while covering any knowledge gaps readers may have.
102+
103+
### Tagging Tutorials
104+
* Tag tutorials with the appropriate product, language (driver or
105+
shell), topics, and difficulty tags. Add tags to tutorial pages by
106+
including a `tags` array containing the string identifiers of each tag
107+
in the tutorial page's headmatter. Tag identifiers, display names, and
108+
facet group (e.g., language, product, etc.) are stored in the
109+
`config.toml` in the following format:
110+
111+
~~~
112+
[tags]
113+
[tags.mongodb] # Format is [tags.id], mongodb is the tag ID
114+
name = "MongoDB"
115+
facet = "product"
116+
117+
[tags.administration] # administration is the tag ID
118+
name = "Administration"
119+
facet = "topic"
120+
121+
# Additional tags would go here...
122+
~~~
123+
124+
The following example adds the "MongoDB", "Administration",
125+
"Replication", and "Beginner" tags to the "Deploy a Replica Set"
126+
tutorial:
127+
128+
~~~
129+
+++
130+
title = "Deploy a Replica Set"
131+
132+
tags = [ "mongodb", "administration", "replication", "beginner" ]
133+
+++
134+
~~~
135+
136+
* Consider the tutorial's audience when tagging the difficulty level.
137+
See the following suggested difficulty levels based on certain topics:
138+
* **Beginner** - Installing and connecting to MongoDB, configuring a
139+
replica set, CRUD, and other topics geared towards new MongoDB users.
140+
* **Intermediate** - Basic security and encryption (e.g., AUTH, SCRAM-SHA1,
141+
x.509, TLS/SSL, managing users and roles), deploying a sharded cluster
142+
and other topics geared towards experienced MongoDB users.
143+
* **Advanced** - Sharding (anything beyond deploying a sharded cluster),
144+
enterprise security (LDAP, Kerberos, and Active Directory),
145+
upgrade/downgrade proceedures and other topics geared towards highly
146+
experienced DBAs and developers in an enterprise setting or a setting
147+
with a large MongoDB deployment.
148+
* New tags must be added to the `config.toml` file. Tag identifiers must
149+
be all lowercase with dashes '-' denoting spaces.

‎config.toml

Lines changed: 72 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,75 @@ contentDir = "content-html"
1313
tags = ""
1414

1515
[tags]
16-
shell = "language"
17-
python = "language"
18-
ruby = "language"
19-
compass = "product"
20-
bi = "product"
21-
mongodb = "product"
22-
driver = "product"
23-
beginner = "level"
24-
crud = "topic"
16+
17+
# Language Options
18+
[tags.shell]
19+
name = "Mongo Shell"
20+
facet = "language"
21+
22+
[tags.python]
23+
name = "Python"
24+
facet = "language"
25+
26+
[tags.ruby]
27+
name = "Ruby"
28+
facet = "language"
29+
30+
# Product Options
31+
[tags.mongodb]
32+
name = "MongoDB"
33+
facet = "product"
34+
35+
[tags.mongodb-enterprise]
36+
name = "MongoDB Enterprise"
37+
facet = "product"
38+
39+
[tags.bi]
40+
name = "BI Connector"
41+
facet = "product"
42+
43+
[tags.compass]
44+
name = "Compass"
45+
facet = "product"
46+
47+
[tags.driver]
48+
name = "Driver"
49+
facet = "product"
50+
51+
# Topic Options
52+
[tags.administration]
53+
name = "Administration"
54+
facet = "topic"
55+
56+
[tags.crud]
57+
name = "CRUD"
58+
facet = "topic"
59+
60+
[tags.performance]
61+
name = "Performance"
62+
facet = "topic"
63+
64+
[tags.replication]
65+
name = "Replication"
66+
facet = "topic"
67+
68+
[tags.security]
69+
name = "Security"
70+
facet = "topic"
71+
72+
[tags.sharding]
73+
name = "Sharding"
74+
facet = "topic"
75+
76+
# Level Options
77+
[tags.beginner]
78+
name = "Beginner"
79+
facet = "level"
80+
81+
[tags.intermediate]
82+
name = "Intermediate"
83+
facet = "level"
84+
85+
[tags.advanced]
86+
name = "Advanced"
87+
facet = "level"

‎content/2.6-downgrade.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
+++
22
title = "Downgrade MongoDB from 2.6"
33

4-
[tags]
5-
mongodb = "product"
4+
tags = [
5+
"mongodb",
6+
"administration",
7+
"replication",
8+
"sharding",
9+
"advanced" ]
610
+++
711

812
# Downgrade MongoDB from 2.6

‎content/2.6-upgrade-authorization.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
+++
22
title = "Upgrade User Authorization Data to 2.6 Format"
33

4-
[tags]
5-
mongodb = "product"
4+
tags = [
5+
"mongodb",
6+
"administration",
7+
"security",
8+
"replication",
9+
"sharding",
10+
"intermediate" ]
611
+++
712

813
<span id="upgrade-authorization-model"></span>

‎content/2.6-upgrade.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
+++
22
title = "Upgrade MongoDB to 2.6"
33

4-
[tags]
5-
mongodb = "product"
4+
tags = [
5+
"mongodb",
6+
"administration",
7+
"replication",
8+
"sharding",
9+
"advanced" ]
610
+++
711

812
# Upgrade MongoDB to 2.6

‎content/3.0-downgrade.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
+++
22
title = "Downgrade MongoDB from 3.0"
33

4-
[tags]
5-
mongodb = "product"
4+
tags = [
5+
"mongodb",
6+
"administration",
7+
"replication",
8+
"sharding",
9+
"advanced" ]
610
+++
711

812
# Downgrade MongoDB from 3.0

‎content/3.0-scram.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
+++
22
title = "Upgrade to SCRAM-SHA-1"
33

4-
[tags]
5-
mongodb = "product"
4+
tags = [
5+
"mongodb",
6+
"security",
7+
"administration",
8+
"intermediate" ]
69
+++
710

811
<span id="scram"></span>

‎content/3.0-upgrade.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
+++
22
title = "Upgrade MongoDB to 3.0"
33

4-
[tags]
5-
mongodb = "product"
4+
tags = [
5+
"mongodb",
6+
"administration",
7+
"sharding",
8+
"replication",
9+
"advanced" ]
610
+++
711

812
# Upgrade MongoDB to 3.0

‎content/3.2-downgrade.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
+++
22
title = "Downgrade MongoDB from 3.2"
33

4-
[tags]
5-
mongodb = "product"
4+
tags = [
5+
"mongodb",
6+
"administration",
7+
"sharding",
8+
"replication",
9+
"advanced" ]
610
+++
711

812
# Downgrade MongoDB from 3.2

‎content/3.2-upgrade.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
+++
22
title = "Upgrade MongoDB to 3.2"
33

4-
[tags]
5-
mongodb = "product"
4+
tags = [
5+
"mongodb",
6+
"administration",
7+
"sharding",
8+
"replication",
9+
"advanced" ]
610
+++
711

812
# Upgrade MongoDB to 3.2

0 commit comments

Comments
 (0)