I18n/crowdin setup2

.github/dependabot.yml

@@ -0,0 +1,41 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "02:00"
+    open-pull-requests-limit: 2
+    groups:
+      minor-and-patch:
+        applies-to: version-updates
+        update-types:
+        - "patch"
+        - "minor"
+      major:
+        applies-to: version-updates
+        update-types:
+        - "major"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "02:00"
+    open-pull-requests-limit: 2
+    groups:
+      all-actions:
+        applies-to: version-updates
+        patterns: [ "*" ]
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "02:00"
+    open-pull-requests-limit: 2
+    groups:
+      all-docker:
+        applies-to: version-updates
+        patterns: [ "*" ]

.github/workflows/copy-workflow.yml

@@ -0,0 +1,74 @@
+name: Crowdin Copy and Create PR
+
+on:
+  workflow_dispatch:
+  # push:
+  #   paths: [ 'docs/**', 'platforms/**','i18n/en/**', 'src/pages/**', 'meeting-notes/**' ]
+  #   branches: [ main ]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  crowdin_copy_and_pr:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Merge latest changes from origin/main
+        run: |
+          git fetch origin
+          git checkout main
+          git merge origin/main
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run crowdin:fix
+        run: yarn run crowdin:fix
+
+      - name: Configure Git
+        run: |
+          git config --global user.name 'github-actions'
+          git config --global user.email 'github-actions@github.com'
+
+      - name: Check for changes
+        id: changes
+        run: |
+          if git diff --quiet; then
+            echo "changes=false" >> $GITHUB_OUTPUT
+          else
+            echo "changes=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create and push changes to branch
+        if: steps.changes.outputs.changes == 'true'
+        run: |
+          BRANCH_NAME="crowdin-copy-changes"
+          git push origin --delete $BRANCH_NAME || true
+          git checkout -b $BRANCH_NAME
+          git add .
+          git commit -m "chore: Copy ignored files using crowdin:fix"
+          git push --force --set-upstream origin $BRANCH_NAME
+          echo "branch_name=$BRANCH_NAME" >> $GITHUB_ENV
+
+      - name: Install GitHub CLI
+        if: steps.changes.outputs.changes == 'true'
+        run: sudo apt-get install -y gh
+
+      - name: Create Pull Request
+        if: steps.changes.outputs.changes == 'true'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr create --repo ${{ github.repository }} --base main --head ${{ env.branch_name }} --title "Copy ignored files using crowdin:fix" --body "This PR was created by GitHub Actions to copy ignored files using the crowdin:fix command."

.github/workflows/download-workflow.yml

@@ -0,0 +1,37 @@
+name: Crowdin Download Action
+
+on:
+  workflow_dispatch:
+  ### Schedule currently disabled ###
+  # schedule:
+  #   - cron: '0 9 * * *'
+  #   - cron: '0 13 * * *'
+  #   - cron: '0 17 * * *'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  crowdin:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Synchronize with Crowdin
+        uses: crowdin/github-action@v2
+        with:
+          upload_sources: false
+          upload_translations: false
+          download_translations: true
+          localization_branch_name: l10n_crowdin_translations
+
+          create_pull_request: true
+          pull_request_title: 'New Crowdin translations'
+          pull_request_body: 'New Crowdin pull request with translations'
+          pull_request_base_branch_name: 'main'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CROWDIN_PROJECT_ID: '669532'
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

.github/workflows/main.yml

@@ -2,7 +2,7 @@ name: Format MDX and Lint
 
 on:
   pull_request:
-    branches:    
+    branches:
       - main
 
   workflow_dispatch:
@@ -13,20 +13,25 @@ jobs:
 
     steps:
       - name: Checkout App Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: '16'
+          node-version: '20'
           cache: 'yarn'
           cache-dependency-path: '**/yarn.lock'
 
       - name: Install App Dependencies
         run: yarn --prefer-offline
 
-      - name: Format MDX with Prettier
+      - name: Copy Files From Stellar CLI
+        run: yarn stellar-cli:build
+
+      - name: Check MDX
         run: yarn check:mdx
 
-      - name: Lint with ESLint
-        run: yarn lint:fix
+      - name: Build app
+        run: yarn build --locale en
+
+

.github/workflows/update-completed-sprint-on-issue-closed.yaml

@@ -0,0 +1,23 @@
+name: Update CompletedSprint on Issue Closed
+
+on:
+  issues:
+    types: [closed]
+
+jobs:
+  update-completed-sprint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate token
+        id: generate_token
+        uses: tibdex/github-app-token@v2
+        with:
+          app_id: ${{ secrets.GH_PROJECT_MANAGEMENT_APP_ID }}
+          private_key: ${{ secrets.GH_PROJECT_MANAGEMENT_APP_PEM }}
+      - name: Update CompletedSprint on Issue Closed
+        id: update_completedsprint_on_issue_closed
+        uses: stellar/actions/update-completed-sprint-on-issue-closed@main
+        with:
+          project_name: "Platform Scrum"
+          field_name: "CompletedSprint"
+          project_token: ${{ steps.generate_token.outputs.token }}

.github/workflows/upload-workflow.yml

@@ -0,0 +1,36 @@
+name: Crowdin Upload
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ main ]
+
+jobs:
+  crowdin-upload:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Docs Repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'yarn'
+          cache-dependency-path: '**/yarn.lock'
+
+      - name: Install Dependencies
+        run: yarn --prefer-offline
+
+      - name: Write Translations
+        run: yarn write-translations
+
+      - name: Crowdin push
+        uses: crowdin/github-action@v2
+        with:
+          upload_sources: true
+          upload_translations: false
+          download_translations: false
+        env:
+          CROWDIN_PROJECT_ID: '669532'
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

.gitignore

@@ -18,3 +18,17 @@ node_modules
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+.idea
+
+*.info.mdx
+
+# non-production openrpc.json files
+/openrpc/*openrpc.json
+
+# Environment variables
+.env
+
+# translation files
+i18n
+stellar-cli-repo

.husky/pre-commit

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+G='\033[0;32m'
+P='\033[0;35m'
+CLEAN='\033[0;0m'
+
+yarn run check:mdx || (echo -e "${G}Hint:${CLEAN} execute ${P}yarn run format:mdx${CLEAN} to format files" && exit 1)

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

.nvmrc

@@ -0,0 +1 @@
+v20

.prettierignore

@@ -0,0 +1,3 @@
+# openapi generated pages
+**/*.api.mdx
+**/*.tag.mdx

Dockerfile

@@ -1,4 +1,4 @@
-FROM ubuntu:20.04 as build
+FROM ubuntu:24.04 AS build
 
 LABEL maintainer="SDF Ops Team <ops@stellar.org>"
 
@@ -8,18 +8,28 @@ WORKDIR /app
 ENV DEBIAN_FRONTEND=noninteractive
 ENV INLINE_RUNTIME_CHUNK=false
 RUN apt-get update && apt-get install --no-install-recommends -y gpg curl git make ca-certificates apt-transport-https && \
-    curl -sSL https://deb.nodesource.com/gpgkey/nodesource.gpg.key|gpg --dearmor >/etc/apt/trusted.gpg.d/nodesource.gpg && \
-    echo "deb https://deb.nodesource.com/node_16.x focal main" | tee /etc/apt/sources.list.d/nodesource.list && \
+    curl -sSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key|gpg --dearmor >/etc/apt/trusted.gpg.d/nodesource-key.gpg && \
+    echo "deb https://deb.nodesource.com/node_20.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list && \
     curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg |gpg --dearmor >/etc/apt/trusted.gpg.d/yarnpkg.gpg && \
     echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
     apt-get update && apt-get install -y nodejs yarn && apt-get clean
 
 COPY . /app/
+ARG CROWDIN_PERSONAL_TOKEN
 
 RUN yarn install
-RUN yarn build
+RUN yarn rpcspec:build
+RUN yarn stellar-cli:build
+# TODO: This takes a bit of time, we should probably make sure it's only done
+# for production builds
+# See: https://docusaurus.io/docs/3.4.0/i18n/crowdin#automate-with-ci
+RUN CROWDIN_PERSONAL_TOKEN=${CROWDIN_PERSONAL_TOKEN} yarn crowdin:sync
+RUN yarn crowdin:fix
+# TODO: It's actually this part that is more time-consuming. The best way to
+# speed this up is to generate the preview for only `--locale en`
+RUN NODE_OPTIONS="--max-old-space-size=4096" yarn build
 
-FROM nginx:1.17
+FROM nginx:1.27
 
 COPY --from=build /app/build/ /usr/share/nginx/html/
-COPY nginx /etc/nginx/
+COPY nginx /etc/nginx/

LICENSE

@@ -187,7 +187,8 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 Stellar Development Foundation
+   Copyright 2014 - 2024 Stellar Development Foundation
+   Copyright 2014 - 2024 Stellar Open Source Developers
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

Makefile

@@ -9,7 +9,7 @@ TAG ?= stellar/stellar-docs:$(LABEL)
 BUILD_DATE := $(shell date -u +%FT%TZ)
 
 docker-build:
-	$(SUDO) docker build --no-cache --pull --label org.opencontainers.image.created="$(BUILD_DATE)" -t $(TAG) .
+	$(SUDO) docker build --no-cache --pull --label org.opencontainers.image.created="$(BUILD_DATE)" -t $(TAG) . --build-arg CROWDIN_PERSONAL_TOKEN=${CROWDIN_PERSONAL_TOKEN}
 
 docker-push:
 	$(SUDO) docker push $(TAG)