Merge branch 'worker-best-practices' of https://github.com/temporalio/documentation into worker-best-practices

Author: lennessyy

.github/CODEOWNERS

@@ -1 +1,8 @@
 * @temporalio/education
+
+# PM owners of sensitive pages
+docs/evaluate/temporal-cloud/pricing.mdx @tlotemporal
+docs/evaluate/temporal-cloud/support.mdx @tlotemporal
+docs/evaluate/temporal-cloud/sla.mdx @bechols
+docs/evaluate/temporal-cloud/limits.mdx @bechols
+docs/evaluate/temporal-cloud/service-availability.mdx @bechols

.github/workflows/update-cli-docs.yml

@@ -59,29 +59,33 @@ jobs:
           go-version: '1.22'
 
       - name: Generate CLI docs
-        working-directory: cli/temporalcli/internal/cmd/gen-docs
+        working-directory: cli/internal/cmd/gen-docs
         run: |
           go run .
 
       - name: Publish generated docs to documentation repo
         env:
           GH_TOKEN: ${{ github.token }}
+          COMMIT_AUTHOR: ${{ github.event.inputs.commit_author }}
+          COMMIT_AUTHOR_EMAIL: ${{ github.event.inputs.commit_author_email }}
+          CLI_RELEASE_TAG: ${{ github.event.inputs.cli_release_tag }}
+          COMMIT_MESSAGE: ${{ github.event.inputs.commit_message }}
         working-directory: docs
         run: |
           set -ex
 
-          git config user.name "${{ github.event.inputs.commit_author }}"
-          git config user.email "${{ github.event.inputs.commit_author_email }}"
-          
-          branch_name="update-cli-docs-${{ github.event.inputs.cli_release_tag }}"
-          git checkout -b $branch_name
-          cp ../cli/temporalcli/docs/*.mdx docs/cli/
+          git config user.name "$COMMIT_AUTHOR"
+          git config user.email "$COMMIT_AUTHOR_EMAIL"
+
+          branch_name="update-cli-docs-$CLI_RELEASE_TAG"
+          git checkout -b "$branch_name"
+          cp ../cli/dist/docs/*.mdx docs/cli/
           git add .
-          git commit -m "${{ github.event.inputs.commit_message }}"
+          git commit -m "$COMMIT_MESSAGE"
           git push origin "$branch_name"
 
           gh pr create \
             --body "Autogenerated PR from https://github.com/temporalio/cli" \
-            --title "${{ github.event.inputs.commit_message }}" \
+            --title "$COMMIT_MESSAGE" \
             --head "$branch_name" \
             --base "main"

.husky/pre-commit

@@ -1 +1 @@
-yarn run lint && yarn run fix-vale
+# yarn run lint && yarn run fix-vale

.prettierrc

@@ -7,5 +7,5 @@
   "semi": true,
   "arrowParens": "always",
   "bracketSpacing": true,
-  "overrides": [{ "files": "**/*.{md,mx}", "options": { "parser": "mdx" } }]
+  "overrides": [{ "files": "**/*.{md,mdx}", "options": { "parser": "mdx" } }]
 }

CONTRIBUTING.md

@@ -1,33 +1,37 @@
 # Contribute to Temporal Documentation Locally 
 
-1. **Clone the Repository**  
+1. **Fork the Repository**
+   Create a fork of this repository.
+   *This creates a copy of this repository to your github account*
+
+2. **Clone the Repository**  
    Run the following commands in your terminal to clone the repository and navigate into it:
    ```bash
    git clone https://github.com/YOUR_USERNAME/documentation.git
    cd documentation
    ```
 
-2. **Open the Repository in Your IDE**  
+3. **Open the Repository in Your IDE**  
    Open the project in your preferred IDE, such as Visual Studio Code. Locate the `/docs` directory, which contains all the content served on `docs.temporal.io`. Identify the changes you want to make.
 
-3. **Create a New Branch**  
+4. **Create a New Branch**  
    If you're creating a pull request, create a new branch and switch to it:  
    ```bash
    git checkout -b my-documentation-contribution
    ```
 
-4. **Follow the Style Guide**  
+5. **Follow the Style Guide**  
    Refer to [STYLE.md](./STYLE.md) for the documentation style guidelines.
 
-5. **Preview Your Changes Locally**  
+6. **Preview Your Changes Locally**  
    Run the following commands to preview the site locally:
    ```bash
    yarn            # Install site dependencies
    yarn start      # Start the website on a local port
    yarn build      # Check for build warnings or errors
    ```
 
-6. **Stage Your Changes**  
+7. **Stage Your Changes**  
    Use the following commands to stage and commit your changes:
    ```bash
    git status                         # Check the status of your changes
@@ -36,7 +40,7 @@
    git push origin my-documentation-contribution  # Push changes
    ```
 
-7. **Create a Pull Request**  
+8. **Create a Pull Request**  
    - After pushing, GitHub provides a link in the terminal to create a PR. Open the link or navigate to your fork on GitHub.
    - Click the option to create a Pull Request (PR).
    - Provide a descriptive PR title and explanation.