Pull in connection docs if they exist

Author: taylorreece

src/plugins/connectors/index.ts

@@ -24,6 +24,9 @@ handlebars.registerPartial(
   }),
 );
 
+// We skip importing certain connectors' connection docs because they are too Prismatic-specific
+const IGNORED_CONNECTOR_CONNECTION_DOCS = ["pipedrive"];
+
 const writeConnectorDocsFile = (
   connector: Component,
   connectorTemplate: HandlebarsTemplateDelegate<unknown>,
@@ -58,6 +61,33 @@ async function generateConnectorDocs({
       JSON.stringify(connectors, null, 2),
     );
     for (const connector of connectors) {
+      for (const connection of connector.connections.nodes) {
+        const docsPath = path.join(
+          __dirname,
+          "..",
+          "..",
+          "..",
+          "..",
+          "components",
+          "components",
+          connector.key,
+          "documentation",
+          "connections",
+          `${connection.key}.mdx`,
+        );
+        if (
+          fs.existsSync(docsPath) &&
+          !IGNORED_CONNECTOR_CONNECTION_DOCS.includes(connector.key)
+        ) {
+          connection.connectionDocs = fs
+            .readFileSync(docsPath, { encoding: "utf-8" })
+            .replaceAll(
+              /<OauthCallbackUrl \/>/g,
+              "`https://oauth2.%WHITE_LABEL_BASE_URL%/callback`",
+            );
+        }
+      }
+
       fetchConnectorIcon(connector);
       writeConnectorDocsFile(connector, connectorTemplate);
     }

src/plugins/connectors/queries.ts

@@ -4,7 +4,7 @@ export interface Component {
   description: string;
   category: string;
   iconUrl: string;
-  connections: { nodes: Connection };
+  connections: { nodes: Connection[] };
   triggers: { nodes: Trigger[] };
   dataSources: { nodes: DataSource[] };
   actions: { nodes: Action[] };
@@ -16,6 +16,7 @@ interface Connection {
   type: string;
   default: string;
   comments: string;
+  connectionDocs?: string;
 }
 
 interface Trigger {

src/plugins/connectors/templates/connector.md.hbs

@@ -17,6 +17,12 @@ description: {{{description}}}
 
 {{{comments}}}
 
+{{#if connectionDocs}}
+
+{{{connectionDocs}}}
+
+{{/if}}
+
 {{#if oauth2Type}}
 
 This connection uses OAuth 2.0, a common authentication mechanism for integrations.