add docs link utility script to scripts folder

Author: paigecalvert

scripts/README.md

@@ -0,0 +1,34 @@
+# Documentation Utility Scripts
+
+This directory contains utility scripts for maintaining the Replicated documentation.
+
+## Available Scripts
+
+### `update_docs_links.sh`
+
+This script updates cross-reference link text throughout the documentation to maintain consistency when page titles change.
+
+#### Usage
+
+1. Edit the `patterns` array in the script to include the search and replacement patterns in the format `"[old title]:[new title]"`
+2. Run the script from the root of the repository:
+   ```
+   bash scripts/update_docs_links.sh
+   ```
+3. Review the changes with `git diff`
+4. Run `npm run build` to verify that links still work
+5. Commit the changes
+
+#### Features
+
+- Updates both "see [Title]" and "See [Title]" references
+- Searches in docs/reference, docs/enterprise, docs/partials, and docs/vendor directories
+- Excludes .history directories from the search
+
+## Adding New Scripts
+
+When adding new utility scripts to this directory:
+
+- Make sure the script is executable: `chmod +x scripts/your_script.sh`
+- Document the script's purpose and usage in this README
+- Include helpful comments within the script itself 

scripts/update_docs_links.sh

@@ -0,0 +1,55 @@
+#!/bin/bash
+
+# Script to update cross-reference link text
+# Run from the root of the replicated-docs repository after changing the title of one or more pages
+
+echo "Updating cross-references..."
+
+# Define replacement patterns with the format "[search pattern]:[replacement]"
+patterns=(
+  # "Adding Nodes to kURL Clusters:Add Nodes to kURL Clusters"
+)
+
+# # Count of files processed and replacements made
+# files_processed=0
+# replacements_made=0
+
+echo "Searching in the /docs directory..."
+
+# Process each file in the docs directory
+# Exclude .history
+find docs -type f -name "*.md*" -not -path "*/\.history/*" | while read file; do
+  file_modified=false
+  
+  # Process each replacement pair
+  for pattern_pair in "${patterns[@]}"; do
+    # Split the pattern_pair into search and replacement parts
+    IFS=':' read -r search replacement <<< "$pattern_pair"
+    
+    # Check if file contains the pattern
+    if grep -q "see \[${search}\]" "$file" || grep -q "See \[${search}\]" "$file"; then
+      # Make the replacements
+      sed -i '' "s/see \[${search}\]/see \[${replacement}\]/g" "$file"
+      sed -i '' "s/See \[${search}\]/See \[${replacement}\]/g" "$file"
+      
+      echo "In $file:"
+      echo "  Replaced: '$search' → '$replacement'"
+      
+      file_modified=true
+      ((replacements_made++))
+    fi
+  done
+  
+  if $file_modified; then
+    ((files_processed++))
+  fi
+done
+
+echo "Done!"
+# echo "Files processed: $files_processed"
+# echo "Total replacements made: $replacements_made"
+# Instructions for verifying changes
+echo "Next steps:"
+echo "1. Review the changes using 'git diff'"
+echo "2. Run 'npm run build' to check for broken links"
+echo "3. Commit the changes if everything looks good"

update_docs_links.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+
+# Script to update cross-reference link text
+# To run: 'bash scripts/update_docs_links.sh' from the root of the replicated-docs repository
+# Run this script after changing the title of one or more pages in the docs directory
+
+# Define replacement patterns with the format "[search pattern]:[replacement]"
+patterns=(
+  # "Adding Nodes to kURL Clusters:Add Nodes to kURL Clusters"
+)
+
+# # Count of files processed and replacements made
+# files_processed=0
+# replacements_made=0
+
+echo "Searching in the /docs directory and updating cross-references..."
+
+# Process each file in the docs directory
+# Exclude .history
+find docs -type f -name "*.md*" -not -path "*/\.history/*" | while read file; do
+  file_modified=false
+  
+  # Process each replacement pair
+  for pattern_pair in "${patterns[@]}"; do
+    # Split the pattern_pair into search and replacement parts
+    IFS=':' read -r search replacement <<< "$pattern_pair"
+    
+    # Check if file contains the pattern
+    if grep -q "see \[${search}\]" "$file" || grep -q "See \[${search}\]" "$file"; then
+      # Make the replacements
+      sed -i '' "s/see \[${search}\]/see \[${replacement}\]/g" "$file"
+      sed -i '' "s/See \[${search}\]/See \[${replacement}\]/g" "$file"
+      
+      echo "In $file:"
+      echo "  Replaced: '$search' → '$replacement'"
+      
+      file_modified=true
+      ((replacements_made++))
+    fi
+  done
+  
+  if $file_modified; then
+    ((files_processed++))
+  fi
+done
+
+echo "Done!"
+# echo "Files processed: $files_processed"
+# echo "Total replacements made: $replacements_made"
+# Instructions for verifying changes
+echo "Next steps:"
+echo "1. Review the changes using 'git diff'"
+echo "2. Run 'npm run build' to check for broken links"
+echo "3. Commit the changes if everything looks good"