From 15d467eaf1a1b840f46279c227c4529cd8a68d2d Mon Sep 17 00:00:00 2001
From: Zach Shilton <4624598+zchsh@users.noreply.github.com>
Date: Sat, 20 Mar 2021 21:45:12 -0400
Subject: [PATCH] website: fix outdated comment

---
 website/components/remote-plugin-docs/server.js | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/website/components/remote-plugin-docs/server.js b/website/components/remote-plugin-docs/server.js
index 9b00b6f92..6054b78f1 100644
--- a/website/components/remote-plugin-docs/server.js
+++ b/website/components/remote-plugin-docs/server.js
@@ -31,8 +31,8 @@ async function generateStaticProps(
     ? remoteFile.fileString
     : fs.readFileSync(path.join(process.cwd(), filePath), 'utf8')
   // Construct the githubFileUrl, used for "Edit this page" link
-  // Note: for custom ".docs-artifacts" directories, the "Edit this page"
-  // link will lead to the artifact file rather than the "docs" source file
+  // Note: we expect remote files, such as those used to render plugin docs,
+  // to have a sourceUrl defined, that points to the file we built from
   const githubFileUrl = remoteFile
     ? remoteFile.sourceUrl
     : `https://github.com/hashicorp/${product.slug}/blob/${mainBranch}/website/${filePath}`