DOCSP-700: Ensure consistent tag ordering

Author: i80and

config.toml

@@ -12,76 +12,93 @@ contentDir = "content-html"
   category = ""
   tags = ""
 
-[tags]
+# Tags
 
-  # Language Options
-  [tags.shell]
+# Language Options
+[[tags]]
+  id = "shell"
   name = "Mongo Shell"
   facet = "language"
-  
-  [tags.python]
+
+[[tags]]
+  id = "python"
   name = "Python"
   facet = "language"
-  
-  [tags.ruby]
+
+[[tags]]
+  id = "ruby"
   name = "Ruby"
   facet = "language"
-  
-  # Product Options
-  [tags.mongodb]
+
+# Product Options
+[[tags]]
+  id = "mongodb"
   name = "MongoDB"
   facet = "product"
-  
-  [tags.mongodb-enterprise]
+
+[[tags]]
+  id = "mongodb-enterprise"
   name = "MongoDB Enterprise"
   facet = "product"
-  
-  [tags.bi]
+
+[[tags]]
+  id = "bi"
   name = "BI Connector"
   facet = "product"
-  
-  [tags.compass]
+
+[[tags]]
+  id = "compass"
   name = "Compass"
   facet = "product"
-  
-  [tags.driver]
+
+[[tags]]
+  id = "driver"
   name = "Driver"
   facet = "product"
-  
-  # Topic Options
-  [tags.administration]
+
+# Topic Options
+[[tags]]
+  id = "administration"
   name = "Administration"
   facet = "topic"
-  
-  [tags.crud]
+
+[[tags]]
+  id = "crud"
   name = "CRUD"
   facet = "topic"
-  
-  [tags.performance]
+
+[[tags]]
+  id = "performance"
   name = "Performance"
   facet = "topic"
-  
-  [tags.replication]
+
+[[tags]]
+  id = "replication"
   name = "Replication"
   facet = "topic"
-  
-  [tags.security]
+
+[[tags]]
+  id = "security"
   name = "Security"
   facet = "topic"
-  
-  [tags.sharding]
+
+[[tags]]
+  id = "sharding"
   name = "Sharding"
   facet = "topic"
-  
-  # Level Options
-  [tags.beginner]
+
+# Level Options
+[[tags]]
+  id = "beginner"
   name = "Beginner"
   facet = "level"
-  
-  [tags.intermediate]
+
+[[tags]]
+  id = "intermediate"
   name = "Intermediate"
   facet = "level"
-  
-  [tags.advanced]
+
+[[tags]]
+  id = "advanced"
   name = "Advanced"
   facet = "level"

tools/genindex.js

@@ -164,7 +164,12 @@ function main() {
     const args = docopt.docopt(__doc__)
     const tutorials = []
     const config = toml.parse(fs.readFileSync(args['--config']))
-    const tagManifest = config.tags || {}
+    const tagManifest = config.tags || []
+    const tagIndexes = new Map()
+    const tagMap = new Map(tagManifest.map((tag, index) => {
+        tagIndexes.set(tag.id, index)
+        return [tag.id, tag]
+    }))
     let error = false
 
     const sourceContentDir = config.sourceContentDir.replace(/\/$/, '')
@@ -185,17 +190,18 @@ function main() {
         }
 
         doc.headmatter.options.forEach(function(option) {
-          if (tagManifest[option] === undefined) {
+          if (!tagMap.has(option)) {
             console.error(`Unknown tag "${option}" in ${path}`)
             error = true
           }
         })
 
-        doc.headmatter.options = doc.headmatter.options.map(option => {
-          // Add the ID from the TOML to the object
-          let tagWithId = tagManifest[option]
-          tagWithId.id = option
-          return tagWithId
+        // Add facet and title information
+        doc.headmatter.options = doc.headmatter.options.map(option => tagMap.get(option))
+
+        // Ensure that tags have a consistent order defined by the config file
+        doc.headmatter.options.sort((a, b) => {
+            return tagIndexes.get(a.id) - tagIndexes.get(b.id)
         })
 
         tutorials.push(doc.headmatter)
@@ -209,7 +215,7 @@ function main() {
 
     let tags = []
 
-    for (const tag of Object.keys(tagManifest)) {     
+    for (const tag of Object.keys(tagManifest)) {
       let tagWithId = tagManifest[tag]
       tagWithId.id = tag
       tags.push(tagWithId)