strip back to simple test script for a single redirect

Author: rosieyohannan

.circleci/config.yml

@@ -207,19 +207,13 @@ jobs:
             echo "[INFO] Deploying production site..."
             aws s3 sync "$BUILD_DIRECTORY" "s3://$AWS_S3_BUCKET/"
       - run:
-          name: Install Python Dependencies for Redirects
-          command: |
-            set -e
-            echo "[INFO] Installing PyYAML for redirect processing..."
-            sudo pip3 install PyYAML
-      - run:
-          name: Deploy Redirects to S3
+          name: Deploy Single Test Redirect to S3
           command: |
             AWS_S3_BUCKET=<< parameters.bucket_name >>
 
             set -e
-            echo "[INFO] Deploying redirects with batch processing..."
-            bash scripts/deploy-redirects-batch.sh "$AWS_S3_BUCKET" "scripts/test-single-redirect.yml"
+            echo "[INFO] Deploying single test redirect..."
+            bash scripts/test-single-redirect.sh "$AWS_S3_BUCKET"
       - notify_error:
           message: "Production deployment job failed for branch ${CIRCLE_BRANCH}"
 

scripts/README-redirects.md

@@ -1,96 +1,39 @@
-# S3 Redirects Deployment System
+# S3 Redirects Test
 
-This documentation explains how to deploy URL redirects for the CircleCI documentation site using AWS S3's website redirect functionality.
+Simple test setup to validate AWS S3 website redirect functionality for the CircleCI documentation site.
 
 ## Overview
 
-The redirect system uses AWS S3's built-in website redirect feature by creating empty objects with redirect metadata. When a user visits an old URL, S3 automatically redirects them to the new URL with a 301 (permanent redirect) status.
+This tests S3's built-in website redirect feature by creating an empty object with redirect metadata. When a user visits the old URL, S3 automatically redirects them to the new URL with a 301 (permanent redirect) status.
 
 ## Files
 
-- `scripts/redirects_v2.yml` - YAML file containing all redirect mappings
-- `scripts/deploy-redirects-batch.sh` - Optimized batch deployment script
+- `scripts/test-single-redirect.sh` - Simple test script with hardcoded redirect
+- `scripts/redirects_v2.yml` - Full redirect mappings (for future use)
 
 ## How It Works
 
-1. **Redirect File Format**: The `redirects_v2.yml` file contains redirect mappings:
-   ```yaml
-   - old: /about-circleci/
-     new: /guides/about-circleci/about-circleci/index.html
+1. **Test Redirect**: Hardcoded in the script:
+   ```
+   /about-circleci/ -> /guides/about-circleci/about-circleci/index.html
    ```
 
 2. **Deployment Process**:
-   - Parse the YAML file
-   - For each redirect, create an S3 object at the old path
-   - Set the `x-amz-website-redirect-location` metadata to the new path
+   - Create S3 object at `about-circleci/index.html`
+   - Set `x-amz-website-redirect-location` metadata to new path
    - S3 automatically handles the redirect
 
-3. **URL Mapping**:
-   - Old paths like `/about-circleci/` become S3 objects at `about-circleci/index.html`
-   - When accessed, S3 returns a 301 redirect to the new location
-
 ## Usage
 
-### Deploy Redirects
+### Test Single Redirect
 
-The redirect deployment is integrated into the CircleCI pipeline and runs automatically after the main site deployment.
-
-Manual deployment:
 ```bash
-bash scripts/deploy-redirects-batch.sh "bucket-name" "scripts/redirects_v2.yml"
+bash scripts/test-single-redirect.sh "bucket-name"
 ```
 
+### Manual Testing
 
-
-## Performance Considerations
-
-### Batch Processing
-The `deploy-redirects-batch.sh` script is optimized for handling redirects efficiently:
-- Processes redirects in batches of 50
-- Uses concurrent uploads (10 parallel requests)
-- Includes error handling and retry logic
-- Handles hundreds of redirects quickly
-
-### Rate Limiting
-- The deployment script includes appropriate rate limiting
-- Batch script uses thread pools to manage concurrency
-
-## CircleCI Integration
-
-The redirect deployment is integrated into the `deploy-production` job:
-
-1. **Install Dependencies**: Installs PyYAML for YAML parsing
-2. **Deploy Main Site**: Syncs the Antora build to S3
-3. **Deploy Redirects**: Creates redirect objects using the batch script
-
-## Adding New Redirects
-
-1. Edit `scripts/redirects_v2.yml`
-2. Add new redirect mapping:
-   ```yaml
-   - old: /old-path/
-     new: /new-path/index.html
-   ```
-3. Commit and push - redirects will be deployed automatically
-
-## Redirect Format Guidelines
-
-- **Old paths**: Should start with `/` and can end with or without `/`
-- **New paths**: Should be the full path to the new location
-- **Index files**: Old paths without file extensions automatically get `index.html` appended
-- **Trailing slashes**: Old paths are normalized (trailing slashes removed)
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Permission Errors**: Ensure AWS credentials have S3 write permissions
-2. **YAML Parse Errors**: Validate YAML syntax in redirects file
-3. **S3 Bucket Errors**: Verify bucket name and region settings
-
-### Checking Redirect Status
-
-Use curl to test individual redirects:
+Test the deployed redirect:
 ```bash
 curl -I "https://circleci.com/docs/about-circleci/"
 ```
@@ -101,19 +44,30 @@ HTTP/1.1 301 Moved Permanently
 Location: /guides/about-circleci/about-circleci/index.html
 ```
 
-### Debugging
+## CircleCI Integration
+
+The redirect test is integrated into the `deploy-production` job:
+
+1. **Deploy Main Site**: Syncs the Antora build to S3
+2. **Deploy Test Redirect**: Creates single redirect object
 
-1. Check CircleCI logs for deployment errors
-2. Test redirects manually with curl or browser
-3. Manually inspect S3 objects and their metadata
+## AWS Command
+
+The core redirect is created with:
+```bash
+aws s3api put-object \
+    --bucket bucket-name \
+    --key about-circleci/index.html \
+    --website-redirect-location /guides/about-circleci/about-circleci/index.html \
+    --content-type text/html \
+    --content-length 0
+```
 
-## Best Practices
+## Next Steps
 
-1. **Test Manually**: Use curl or browser to spot-check redirects when needed
-2. **Batch Operations**: Use the batch script for large numbers of redirects
-3. **Monitor Performance**: Keep an eye on deployment times and error rates
-4. **Clean URLs**: Ensure redirect paths are clean and consistent
-5. **Backup**: Keep backup of working redirect files before major changes
+1. Test this single redirect works
+2. If successful, implement batch processing for all 502 redirects in `redirects_v2.yml`
+3. The full redirect system can be found in previous git commits
 
 ## AWS S3 Website Configuration
 

scripts/deploy-redirects-batch.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+set -e
+
+# Check required parameter
+if [ -z "$1" ]; then
+    echo "Usage: $0 <bucket_name>"
+    echo "Example: $0 circleci-docs-platform-assets/docs-preview"
+    exit 1
+fi
+
+BUCKET_NAME="$1"
+
+# Hardcoded single redirect for testing
+OLD_PATH="/about-circleci/"
+NEW_PATH="/guides/about-circleci/about-circleci/index.html"
+
+echo "[INFO] Testing single redirect deployment to bucket: s3://$BUCKET_NAME"
+echo "[INFO] Redirect: $OLD_PATH -> $NEW_PATH"
+
+# Convert old path to S3 key
+S3_KEY="about-circleci/index.html"
+
+echo "[INFO] Creating S3 object: $S3_KEY"
+echo "[INFO] With redirect to: $NEW_PATH"
+
+# Create the redirect object
+aws s3api put-object \
+    --bucket "$BUCKET_NAME" \
+    --key "$S3_KEY" \
+    --website-redirect-location "$NEW_PATH" \
+    --content-type "text/html" \
+    --content-length "0"
+
+echo "[INFO] ✅ Redirect created successfully!"
+echo "[INFO] Test with: curl -I https://your-domain/about-circleci/"