chore(docs): add more 'autogenerated' comments

This should prevent the kind of thing we've seen where people edit the
generated docs, as in #3654 and #3630, and provide them with a helpful
pointer so they put the config documentation changes in the right place.

2 files changed, 12 insertions, 4 deletions

diff --git a/scripts/config-doc-command.js b/scripts/config-doc-command.js
index 48bc02654..085ac958d 100644
--- a/scripts/config-doc-command.js
+++ b/scripts/config-doc-command.js
@@ -9,7 +9,10 @@ const commandFile = process.argv[3]
 const { params } = require(resolve(commandFile))
 
 const describeAll = () =>
-  params.map(name => definitions[name].describe()).join('\n\n')
+  params.map(name => definitions[name].describe()).join(
+    '\n\n<!-- automatically generated, do not edit manually -->\n' +
+      '<!-- see lib/utils/config/definitions.js -->\n\n'
+  )
 
 const addBetweenTags = (doc, startTag, endTag, body) => {
   const startSplit = doc.split(startTag)
@@ -23,8 +26,11 @@ const addBetweenTags = (doc, startTag, endTag, body) => {
   return [
     startSplit[0],
     startTag,
-    '\n<!-- automatically generated, do not edit manually -->\n',
+    '\n<!-- automatically generated, do not edit manually -->\n' +
+      '<!-- see lib/utils/config/definitions.js -->\n',
     body,
+    '\n\n<!-- automatically generated, do not edit manually -->\n' +
+      '<!-- see lib/utils/config/definitions.js -->',
     '\n\n',
     endTag,
     endSplit[1],
diff --git a/scripts/config-doc.js b/scripts/config-doc.js
index 5014bcdc4..03e8fbc2d 100644
--- a/scripts/config-doc.js
+++ b/scripts/config-doc.js
@@ -15,9 +15,11 @@ const addBetweenTags = (doc, startTag, endTag, body) => {
   return [
     startSplit[0],
     startTag,
-    '\n<!-- automatically generated, do not edit manually -->\n',
+    '\n<!-- automatically generated, do not edit manually -->\n' +
+      '<!-- see lib/utils/config/definitions.js -->\n',
     body,
-    '\n\n',
+    '\n\n<!-- automatically generated, do not edit manually -->\n' +
+      '<!-- see lib/utils/config/definitions.js -->\n',
     endTag,
     endSplit[1],
   ].join('')