Merge branch 'main' into doc-645/glossary-component

Author: Piotr1215

.github/styles/Loft/no-indented-admonitions-in-steps.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: "Admonitions inside <Step> components must have zero indentation to avoid MDX parsing errors"
+level: error
+scope: raw
+nonword: true
+tokens:
+  # This pattern specifically matches indented admonitions that appear within <Step> components
+  # It captures the indented ::: line itself, which will position the error correctly
+  - '(?ms)^(?=.*<Step[^>]*>)(?=.*</Step>)[ \t]+:::(note|tip|info|warning|danger|caution|important|success)\b'

.github/workflows/linear-pr-comments.yaml

@@ -1,7 +1,7 @@
 name: Linear PR Comments
 
 on:
-  pull_request:
+  pull_request_target:
     types: [opened, edited]
     branches:
       - main
@@ -23,6 +23,6 @@ jobs:
           pr-number: ${{ github.event.pull_request.number }}
           repo-owner: ${{ github.repository_owner }}
           repo-name: ${{ github.event.repository.name }}
-          github-token: ${{ secrets.GH_ACCESS_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           linear-token: ${{ secrets.LINEAR_API_KEY }}
         timeout-minutes: 3

.github/workflows/validate-glossary.yml

@@ -4,31 +4,30 @@ on:
   pull_request:
     branches: [ main ]
     paths:
-      - 'docs/**/*.mdx'
-      - 'vcluster/**/*.mdx'
-      - 'platform/**/*.mdx'
+      - '**/*.mdx'
       - 'src/data/glossary.yaml'
       - 'src/components/GlossaryTerm/**'
-  
+      - 'scripts/validate-glossary-terms.js'
+
   # Allow manual triggering
   workflow_dispatch:
 
 jobs:
   validate-glossary:
     runs-on: ubuntu-latest
-    
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-      
+
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version: '20'
           cache: 'npm'
-      
+
       - name: Install dependencies
-        run: npm ci
-      
+        run: npm install
+
       - name: Validate glossary terms
         run: npm run validate-glossary

docs/index.mdx

@@ -6,6 +6,5 @@ hide_table_of_contents: false
 ---
 
 import PartialWhatAreVirtualClusters from '../vcluster/_partials/what-are-virtual-clusters.mdx'
-import GlossaryTerm from '@site/src/components/GlossaryTerm'
 
-<PartialWhatAreVirtualClusters />
+<PartialWhatAreVirtualClusters />

platform/administer/connector/database.mdx

@@ -16,7 +16,7 @@ import VersionBadge from '@site/src/components/VersionBadge';
 The database connector feature allows an admin to configure a database server to manage backing stores for multiple virtual clusters. For each virtual cluster, the feature automatically creates an independent database and non-privileged user. Read more about the use of external databases in the [External Database documentation](/docs/vcluster/configure/vcluster-yaml/control-plane/components/backing-store/database/external).
 
 :::note
-This feature currently only supports MySQL database servers. It has been extensively tested for AWS RDS MySQL compatibility.
+This feature only supports MySQL and PostgreSQL database servers. It has been extensively tested for AWS RDS and Aurora compatibility.
 :::
 
 ## Prerequisites
@@ -79,19 +79,20 @@ Modifying a database secret to point to a different database server is not recom
 
 ### Example configuration
 
-The following example is a connector secret for the shared database feature. It is configured for an internal instance of MySQL that is exposed with a ClusterIP service named `mysql` in the `vcluster-platform` namespace (assume this is the namespace the platform is installed in). This could instead be any other endpoint, such as an AWS RDS MySQL endpoint.
+The following example shows a connector secret for the shared database feature. It connects to an internal MySQL instance exposed by a service named `mysql` in the `vcluster-platform` namespace (where the platform is assumed to be installed). You can also use any other MySQL-compatible endpoint, such as an AWS RDS instance.
 
 ```yaml title="Shared database secret example"
 apiVersion: v1
 kind: Secret
 metadata:
   name: default-data-source
-  namespace: vcluster-platform # this must match the namespace that vCluster Platform is in
+  namespace: vcluster-platform # This must match the namespace that vCluster Platform is in.
   labels:
     loft.sh/connector-type: "shared-database"
 stringData:
-  endpoint: mysql.vcluster-platform # this service could be in any namespace
+  endpoint: mysql.vcluster-platform # This service can be in any namespace.
   password: <password>
   port: "3306"
   user: root
+  type: mysql # This can be mysql or postgres. If left blank, the mysql database type is assumed.
 ```

platform/configure/domain.mdx

@@ -254,7 +254,7 @@ ingress:
 If you want to [configure the platform with additionalCA](/platform/configure/config.mdx#using-a-custom-certificate-authority), the Certificate Authority used for signing this certificate has to be added as a base64 encoded value:
 
 ```bash title="Encode CA certificate"
-cat ca.crt | base64 -d
+cat ca.crt | base64
 ```
 
 Use this output in the `.additionalCA` helm value.
@@ -403,7 +403,7 @@ kubectl create secret generic tls-vcluster-platform -n vcluster-platform --type=
 If you want to [configure the platform with additionalCA](/platform/configure/config.mdx#using-a-custom-certificate-authority), use:
 
 ```bash title="Encode CA certificate"
-cat ca.crt | base64 -d
+cat ca.crt | base64
 ```
 
 as an input for the `.additionalCA` helm value.

platform/reference/glossary.mdx

@@ -7,7 +7,9 @@ description: Glossary of terms used in the platform documentation
 
 import glossaryData from '@site/src/data/glossary.yaml';
 
+<!-- vale off -->
 # Platform glossary {#platform-glossary}
+<!-- vale on -->
 
 This page contains definitions for common terms used throughout the platform documentation.
 
@@ -24,7 +26,7 @@ This page contains definitions for common terms used throughout the platform doc
         <p><strong>Related terms:</strong> {entry.related.map((term, index) => (
           <span key={term}>
             {index > 0 && ', '}
-            <a href={`#${term}`}>{glossaryData[term]?.term || term}</a>
+            <span>{glossaryData[term]?.term || term}</span>
           </span>
         ))}</p>
       )}

platform_versioned_docs/version-4.2.0/configure/domain.mdx

@@ -254,7 +254,7 @@ ingress:
 If you want to [configure the platform with additionalCA](/platform/configure/config.mdx#using-a-custom-certificate-authority), the Certificate Authority used for signing this certificate has to be added as a base64 encoded value:
 
 ```bash title="Encode CA certificate"
-cat ca.crt | base64 -d
+cat ca.crt | base64
 ```
 
 Use this output in the `.additionalCA` helm value.
@@ -403,7 +403,7 @@ kubectl create secret generic tls-vcluster-platform -n vcluster-platform --type=
 If you want to [configure the platform with additionalCA](/platform/configure/config.mdx#using-a-custom-certificate-authority), use:
 
 ```bash title="Encode CA certificate"
-cat ca.crt | base64 -d
+cat ca.crt | base64
 ```
 
 as an input for the `.additionalCA` helm value.

scripts/validate-glossary-terms.js

@@ -24,11 +24,28 @@ const glossaryData = yaml.load(fs.readFileSync(glossaryPath, 'utf8'));
 const glossaryTermPattern = /<GlossaryTerm\s+term=["']([^"']+)["']/g;
 
 // Get all MDX files
-const mdxFiles = [
-  ...glob.sync('docs/**/*.mdx'),
-  ...glob.sync('vcluster/**/*.mdx'),
-  ...glob.sync('platform/**/*.mdx'),
-];
+// Handle both glob v7 and v10 formats
+let mdxFiles = [];
+try {
+  // For glob v7
+  mdxFiles = glob.sync('**/*.mdx', {
+    ignore: [
+      'node_modules/**',
+      'build/**',
+      '.docusaurus/**',
+      '.vscode/**'
+    ]
+  });
+} catch (error) {
+  // For newer versions, fall back to the directory-specific approach
+  mdxFiles = [
+    ...glob.sync('docs/**/*.mdx'),
+    ...glob.sync('vcluster/**/*.mdx'),
+    ...glob.sync('platform/**/*.mdx'),
+    ...glob.sync('platform_versioned_docs/**/*.mdx'),
+    ...glob.sync('vcluster_versioned_docs/**/*.mdx'),
+  ];
+}
 
 let hasErrors = false;
 

src/components/GlossaryTerm/index.jsx

@@ -2,45 +2,22 @@ import React from 'react';
 import styles from './styles.module.css';
 import glossaryData from '@site/src/data/glossary.yaml';
 
-// Track terms used per page
-const usedTerms = {};
-
 const GlossaryTerm = ({ term, children }) => {
-  // Get current page path
-  const pagePath = typeof window !== 'undefined' ? window.location.pathname : 'default';
-  
-  // Initialize page tracking if needed
-  if (!usedTerms[pagePath]) {
-    usedTerms[pagePath] = new Set();
-  }
 
   // Get term data
   const termData = glossaryData[term];
 
-  // Check if first occurrence
-  const isFirstOccurrence = !usedTerms[pagePath].has(term);
-  
-  // Mark as used if valid
-  if (isFirstOccurrence && termData) {
-    usedTerms[pagePath].add(term);
-  }
-  
   // Handle missing term data
   if (!termData) {
     return <>{children || term}</>;
   }
 
-  // If not first occurrence, just render normally
-  if (!isFirstOccurrence) {
-    return <>{children || termData.term}</>;
-  }
-  
   // For first occurrence, render with tooltip
   const termContent = children || termData.term;
   const hasUrl = termData.url && termData.url.length > 0;
 
   return (
-    <div className={styles.termWrapper}>
+    <span className={styles.termWrapper}>
       {hasUrl ? (
         <a href={termData.url} className={styles.term}>
           {termContent}
@@ -50,25 +27,39 @@ const GlossaryTerm = ({ term, children }) => {
           {termContent}
         </span>
       )}
-      <div className={styles.tooltip}>
-        <div className={styles.tooltipHeader}>
+      <span className={styles.tooltip}>
+        <span className={styles.tooltipHeader}>
           {hasUrl ? (
             <a href={termData.url} className={styles.tooltipHeaderLink}>
               {termData.term}
             </a>
           ) : (
             termData.term
           )}
-        </div>
-        <div className={styles.tooltipDefinition}>{termData.definition}</div>
+        </span>
+        <span className={styles.tooltipDefinition}>{termData.definition}</span>
         {termData.related && (
-          <div className={styles.related}>
+          <span className={styles.related}>
             <span>Related: </span>
-            {termData.related.join(', ')}
-          </div>
+            {termData.related.map((relatedTermId, index) => {
+              const relatedTerm = glossaryData[relatedTermId];
+              return (
+                <span key={relatedTermId}>
+                  {index > 0 && ', '}
+                  {relatedTerm ? (
+                    <span className={styles.relatedTerm}>
+                      {relatedTerm.term}
+                    </span>
+                  ) : (
+                    relatedTermId
+                  )}
+                </span>
+              );
+            })}
+          </span>
         )}
-      </div>
-    </div>
+      </span>
+    </span>
   );
 };