Merge branch 'main' into DOCSS-1818-deploys-updates

Author: rosieyohannan

.circleci/config.yml

@@ -6,14 +6,20 @@ parameters:
     default: ""
 
 orbs:
-  aws-cli: circleci/[email protected]
+  aws-cli: circleci/[email protected]
+  vale: circleci/[email protected]
 
 executors:
   node_executor:
     docker:
       - image: cimg/node:22.15.1
     working_directory: ~/project
 
+  python_executor:
+    docker:
+      - image: cimg/python:3.12.11
+    working_directory: ~/project
+
   ruby_executor:
     docker:
       - image: cimg/ruby:3.4
@@ -63,9 +69,9 @@ jobs:
     steps:
       - checkout
       - run:
-          name: Fetch branches matching server-*
+          name: Fetch branches matching server-4*
           command: |
-            for branch in $(git ls-remote --heads origin | awk '{print $2}' | grep 'refs/heads/server-' | sed 's|refs/heads/||'); do
+            for branch in $(git ls-remote --heads origin | awk '{print $2}' | grep 'refs/heads/server-4' | sed 's|refs/heads/||'); do
               echo "[INFO] Fetching branch: $branch"
               git checkout "$branch"
               git pull origin "$branch"
@@ -101,14 +107,14 @@ jobs:
           paths:
             - build
             - build.zip
+            - scripts
       - persist_to_workspace:
           root: .
           paths:
             - build
       - notify_error:
           message: "Build job failed for branch ${CIRCLE_BRANCH}"
 
-
   validate:
     executor: ruby_executor
     steps:
@@ -129,7 +135,6 @@ jobs:
       - notify_error:
           message: "Validation job failed for branch ${CIRCLE_BRANCH}"
 
-
   deploy-preview:
     executor: node_executor
     steps:
@@ -184,19 +189,50 @@ jobs:
       - notify_error:
           message: "Deploy preview job failed for branch ${CIRCLE_BRANCH}"
 
-
   deploy-production:
-    executor: node_executor
+    executor: python_executor
+    parameters:
+      bucket_name:
+        description: The name of the s3 bucket where static assets are stored.
+        type: string
+      build_dir:
+        default: "build"
+        description: The path to the docs build directory
+        type: string
     steps:
       - attach_workspace:
           at: .
       - aws-setup
       - run:
           name: Deploy Production Site to S3
           command: |
+            AWS_S3_BUCKET=<< parameters.bucket_name >>
+            BUILD_DIRECTORY=<< parameters.build_dir >>
+
             set -e
             echo "[INFO] Deploying production site..."
-            aws s3 sync build s3://${DOCS_BUILD_BUCKET}/ --delete --endpoint-url ${S3_ENDPOINT}
+            aws s3 sync "$BUILD_DIRECTORY" "s3://$AWS_S3_BUCKET/"
+      - run:
+          name: install pyyaml requests
+          command: |
+            set -e
+            echo "[INFO] Installing pyyaml requests..."
+            pip install pyyaml requests
+      - run:
+          name: Deploy Redirects to S3
+          command: |
+            AWS_S3_BUCKET=<< parameters.bucket_name >>
+
+            set -e
+            echo "[INFO] Deploying redirects..."
+            #REMEMBER TO UPDATE THE START/END PARAMETER IN THE VALIDATE JOB TO MATCH
+            python scripts/create-redirects.py $AWS_S3_BUCKET --start 0 --end 10
+      - run:
+          name: Validate Redirects
+          command: |
+            set -e
+            echo "[INFO] Validating redirects..."
+            python scripts/validate-redirects.py https://circleci.com/docs-preview --start 0 --end 10
       - notify_error:
           message: "Production deployment job failed for branch ${CIRCLE_BRANCH}"
 
@@ -241,8 +277,14 @@ jobs:
               echo "[WARN] Tag '${TAG}' not found."
             fi
 
-
 workflows:
+  lint:
+    unless:
+      equal: [main, << pipeline.git.branch >>]
+    jobs:
+      - vale/lint:
+          reference_branch: main
+          base_dir: docs
   build_validate_and_deploy:
     when:
       equal: ["", << pipeline.parameters.cleanup_preview_branch >>]
@@ -256,13 +298,27 @@ workflows:
           filters:
             branches:
               ignore: main
-          context: circleci-docs-static
+          context:
+            [
+              circleci-docs-static,
+              docs-platform-assets,
+              web-ui-npm,
+              web-ui-datadog,
+            ]
       - deploy-production:
           requires: [validate]
           filters:
             branches:
               only: main
-          context: circleci-docs-static
+          context:
+            [
+              circleci-docs-static,
+              docs-platform-assets,
+              web-ui-npm,
+              web-ui-datadog,
+            ]
+          bucket_name: "circleci-docs-platform-assets"
+          build_dir: "build"
   cleanup_preview:
     when: pipeline.parameters.cleanup_preview_branch != ""
     jobs:

.vale.ini

@@ -0,0 +1,21 @@
+StylesPath = styles
+
+Vocab = Docs
+
+MinAlertLevel = suggestion
+
+Packages = Readability
+
+[asciidoctor]
+# attribute = value
+#
+# where 'YES' enables and 'NO' disables.
+
+# enable
+experimental = YES
+
+# assign a specific value
+attribute-missing = drop
+
+[*.adoc]
+BasedOnStyles = circleci-docs, Vale, Readability, Openly

DEVELOPMENT.md

@@ -84,12 +84,12 @@ The site will be available at `http://localhost:3000` by default.
   npm run build:docs
   ```
 
-- **Fetch server branches** (for server admin docs). You will need to have local copies of all server-* branches to be able to build the full docs site locally:
+- **Fetch server branches** (for server admin docs). You will need to have local copies of all server-4* branches to be able to build the full docs site locally:
   ```bash
   npm run fetch-server-branches
   ```
 
-- **Force fetch server branches** if you want to force all your server-* branches to the state of the upstream "current" versions, use the --force flag. This is recommended if you have no local changes on any server-* branch:
+- **Force fetch server branches** if you want to force all your server-4* branches to the state of the upstream "current" versions, use the --force flag. This is recommended if you have no local changes on any server-4* branch:
 
   ```bash
   npm run fetch-server-branches --force
@@ -257,7 +257,7 @@ When changes are made to the main branch to the build processes, the UI, or all
 3. Run `git rebase main`
 4. Push those changes with `git push --force-with-lease origin server-4.1` - remember to use the correct server branch number.
 
-This should be done for every server-* branch.
+This should be done for every server-4* branch.
 
 ### Creating a New Component
 

README.md

@@ -41,7 +41,7 @@ This technical documentation consists of several specialized files:
    cd circleci-docs-static
    npm ci
    ```
-2. **Make sure you've cloned server-* branches (Server Administration Docs)**
+2. **Make sure you've cloned server-4* branches (Server Administration Docs)**
 
 ```bash
    npm run fetch-server-branches

antora-playbook.yml

@@ -1,6 +1,6 @@
 site:
   title: CircleCI Documentation
-  url: https://circleci.com/docs
+  url: https://circleci.com/docs-preview
   robots: allow
   keys:
     cookiebot: a28b71f3-4d2e-4eac-93bc-34929948dd7d
@@ -16,7 +16,7 @@ content:
     start_path: docs/orbs
   - url: .
     start_path: docs/server-admin
-    branches: [server-*]
+    branches: [server-4*]
   - url: .
     start_path: docs/contributors
 ui:
@@ -46,6 +46,8 @@ asciidoc:
     helmdiffversion: 3.5.0
     kotsversion: 1.65.0
     page-toclevels: 6
+    idprefix: ""
+    idseparator: "-"
   extensions:
   - '@asciidoctor/tabs'
 urls:

archive/server 4.1/server-admin/antora.yml

@@ -0,0 +1,6 @@
+name: server-admin
+title: Server
+version: server-4.1
+display_version: Server 4.1
+nav:
+- modules/ROOT/nav.adoc

archive/server 4.1/server-admin/modules/ROOT/nav.adoc

@@ -0,0 +1,41 @@
+* xref:overview:index.adoc[CircleCI server 4.1]
+** xref:overview:circleci-server-overview.adoc[CircleCI Server Overview]
+** xref:overview:release-notes.adoc[Release notes]
+
+* xref:installation:index.adoc[Installing CircleCI server]
+** xref:installation:phase-1-prerequisites.adoc[Phase 1: Prerequisites]
+** xref:installation:phase-2-core-services.adoc[Phase 2: Core services installation]
+** xref:installation:phase-3-execution-environments.adoc[Phase 3: Execution environments installation]
+** xref:installation:phase-4-post-installation.adoc[Phase 4: Post-installation]
+** xref:installation:hardening-your-cluster.adoc[Hardening your cluster]
+** xref:installation:installing-server-behind-a-proxy.adoc[Installing server behind a proxy]
+** xref:installation:upgrade-server.adoc[Upgrading server]
+** xref:installation:installation-reference.adoc[Installation reference]
+
+* xref:air-gapped-installation:index.adoc[Installing CircleCI server in an air-gapped environment]
+** xref:air-gapped-installation:phase-1-prerequisites.adoc[Phase 1 - Prerequisites]
+** xref:air-gapped-installation:phase-2-configure-object-storage.adoc[Phase 2 - Configure object storage]
+** xref:air-gapped-installation:phase-3-install-circleci-server.adoc[Phase 3 - Install CircleCI server]
+** xref:air-gapped-installation:phase-4-configure-nomad-clients.adoc[Phase 4 - Configure Nomad clients]
+** xref:air-gapped-installation:phase-5-test-your-installation.adoc[Phase 5 - Test installation]
+** xref:air-gapped-installation:additional-considerations.adoc[Additional considerations]
+** xref:air-gapped-installation:example-values.adoc[Example values.yaml]
+
+* xref:operator:index.adoc[CircleCI server operator guide]
+** xref:operator:operator-overview.adoc[Operator overview]
+** xref:operator:introduction-to-nomad-cluster-operation.adoc[Introduction to Nomad cluster operation]
+** xref:operator:managing-user-accounts.adoc[Managing user accounts]
+** xref:operator:managing-orbs.adoc[Managing orbs]
+** xref:operator:manage-virtual-machines-with-vm-service.adoc[Manage virtual machines with VM service]
+** xref:operator:configuring-external-services.adoc[Configuring external services]
+** xref:operator:expanding-internal-database-volumes.adoc[Expanding internal database volumes]
+** xref:operator:managing-load-balancers.adoc[Managing load balancers]
+** xref:operator:user-authentication.adoc[User authentication]
+** xref:operator:managing-build-artifacts.adoc[Managing build artifacts]
+** xref:operator:usage-data-collection.adoc[Usage data collection]
+** xref:operator:circleci-server-security-features.adoc[CircleCI server security features]
+** xref:operator:application-lifecycle.adoc[Application lifecycle]
+** xref:operator:troubleshooting-and-support.adoc[Troubleshooting and support]
+** xref:operator:backup-and-restore.adoc[Backup and restore]
+** xref:operator:upgrade-mongo.adoc[Upgrade MongoDB]
+** xref:operator:faq.adoc[FAQs]

archive/server 4.1/server-admin/modules/ROOT/pages/index.adoc

@@ -0,0 +1,6 @@
+= CircleCI server administration
+:page-noindex: true
+:page-layout: subsection
+:page-description: CircleCI server documentation for installing, configuring, and managing CircleCI server.
+
+CircleCI server is the on-premisis CircleCI platform. In this section you will find the documentation for installing, configuring, and managing CircleCI server.