edits

Author: paigecalvert

docs/vendor/ci-overview.md

@@ -18,7 +18,7 @@ The following are Replicated's best practices and recommendations for CI/CD:
 
 * Integrate Replicated Compatibility Matrix into your CI/CD workflows to quickly create multiple different types of clusters where you can deploy and test your application. Supported distributions include OpenShift, GKE, EKS, and more. For more information, see [About Compatibility Matrix](testing-about).
 
-* If you use the GitHub Actions CI/CD platform, integrate the custom GitHub actions that Replicated maintains to replace repetitive tasks related to distributing application with Replicated or using Compatibility Matrix. For more information, see [Integrating Replicated GitHub Actions](/vendor/ci-workflows-github-actions).
+* If you use the GitHub Actions CI/CD platform, integrate the custom GitHub actions that Replicated maintains to replace repetitive tasks related to distributing application with Replicated or using Compatibility Matrix. For more information, see [Use Replicated GitHub Actions in CI/CD](/vendor/ci-workflows-github-actions).
 
 * To help show you are conforming to a secure supply chain, sign all commits and container images. Additionally, provide a verification mechanism for container images.
 

docs/vendor/ci-workflows.mdx

@@ -8,7 +8,7 @@ This topic provides Replicated's recommended development and release workflows f
 
 Replicated recommends that you maintain unique CI/CD workflows for development (continuous integration) and for releasing your software (continuous delivery). The development and release workflows in this topic describe the recommended steps and jobs to include in your own workflows, including how to integrate Replicated Compatibility Matrix into your workflows for testing. For more information about Compatibility Matrix, see [About Compatibility Matrix](testing-about).
 
-For each step, the corresponding Replicated CLI command is provided. Additionally, for users of the GitHub Actions platform, a corresponding custom GitHub action that is maintained by Replicated is also provided. For more information about using the Replicated CLI, see [Install the Replicated CLI](/reference/replicated-cli-installing). For more information about the Replicated GitHub actions, see [Integrating Replicated GitHub Actions](ci-workflows-github-actions).
+For each step, the corresponding Replicated CLI command is provided. Additionally, for users of the GitHub Actions platform, a corresponding custom GitHub action that is maintained by Replicated is also provided. For more information about using the Replicated CLI, see [Install the Replicated CLI](/reference/replicated-cli-installing). For more information about the Replicated GitHub actions, see [Use Replicated GitHub Actions in CI/CD](ci-workflows-github-actions).
 
 :::note
 How you implement CI/CD workflows varies depending on the platform, such as GitHub, GitLab, CircleCI, TravisCI, or Jenkins. Refer to the documentation for your CI/CD platform for additional guidance on how to create jobs and workflows.

docs/vendor/testing-how-to.md

@@ -300,7 +300,7 @@ If you use GitHub Actions as your CI/CD platform, you can include these custom a
 
 To view all the available GitHub actions that Replicated maintains, see the [replicatedhq/replicated-actions](https://github.com/replicatedhq/replicated-actions/) repository in GitHub.
 
-For more information, see [Integrating Replicated GitHub Actions](/vendor/ci-workflows-github-actions).
+For more information, see [Use Replicated GitHub Actions in CI/CD](/vendor/ci-workflows-github-actions).
 
 ### Recommended Workflows
 

scripts/README.md

@@ -11,19 +11,35 @@ This script updates cross-reference link text throughout the documentation to ma
 #### 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:
+   
+   Example:
+   ```bash
+   patterns=(
+     "Integrating Replicated GitHub Actions:Use Replicated GitHub Actions in CI/CD"
+   )
+   ```
+
+2. Run the script from the root of the replicated-docs 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
+- Searches in all markdown files under the docs directory
 - Excludes .history directories from the search
+- Reports the number of files processed and replacements made
+
+#### Troubleshooting
+
+If the script isn't working as expected:
+- Make sure your pattern is correctly formatted with a colon separating the old and new titles
+- Check that the exact text matches what's in the documentation
 
 ## Adding New Scripts
 

scripts/update_docs_links.sh

@@ -7,18 +7,22 @@ echo "Updating cross-references..."
 
 # Define replacement patterns with the format "[search pattern]:[replacement]"
 patterns=(
-  # "Adding Nodes to kURL Clusters:Add Nodes to kURL Clusters"
+  "Integrating Replicated GitHub Actions:Use Replicated GitHub Actions in CI/CD"
+  # Add more patterns here as needed, one per line
+  # "Old Title:New Title"
 )
 
-# # Count of files processed and replacements made
-# files_processed=0
-# replacements_made=0
+# 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
+# Get all markdown files, excluding .history directories
+files=$(find docs -type f -name "*.md*" -not -path "*/\.history/*")
+
+# Process each file without using a pipe to avoid subshell issues
+for file in $files; do
   file_modified=false
 
   # Process each replacement pair
@@ -28,26 +32,26 @@ find docs -type f -name "*.md*" -not -path "*/\.history/*" | while read file; do
 
     # 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"
+      # Make the replacements - use | as delimiter instead of / to avoid issues with paths
+      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++))
+      replacements_made=$((replacements_made+1))
     fi
   done
 
-  if $file_modified; then
-    ((files_processed++))
+  if [ "$file_modified" = true ]; then
+    files_processed=$((files_processed+1))
   fi
 done
 
 echo "Done!"
-# echo "Files processed: $files_processed"
-# echo "Total replacements made: $replacements_made"
+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'"