From 1902a36ad44a72b2cea3a07fda9773427903e73f Mon Sep 17 00:00:00 2001 From: Aaron Heckmann Date: Tue, 8 Jul 2025 16:54:27 -0700 Subject: [PATCH 1/4] chore: improve repo contribution instructions --- CONTRIBUTING.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f50d7819..e9a40477 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,10 +17,22 @@ git checkout -b ### 3. Make Changes in the Appropriate Page Navigate to the relevant documentation page in the repository and make your changes. Ensure that your changes align with our style guide and maintain consistency across the documentation. -### 4. Raise a Pull Request (PR) +### 4. Preview your changes +Make sure you are visually happy with your changes. + +1. Run `npx mint dev` +1. A url will be printed to your console. Open it in your browser. +1. Visit your pages and confirm they look correct. + +### 5. Fix broken links + +1. Run `npx mint broken-links` +2. Fix all reported broken links + +### 5. Raise a Pull Request (PR) Once your changes are ready, raise a pull request (PR) to merge your branch into the `master` branch. Please provide a descriptive title and detailed description of your changes. -### 5. Leave a Clear Commit Message +### 6. Leave a Clear Commit Message When committing your changes, leave a clear and concise message that links to the corresponding issue (if applicable) and explains the fix or enhancement you've made. ```bash @@ -28,13 +40,13 @@ git add . git commit -m "Fixes #: Description of the fix or enhancement" ``` -### 6. Link the Issue to the Pull Request +### 7. Link the Issue to the Pull Request In your pull request description, be sure to reference the related issue using GitHub's syntax (`#`). This links the PR to the issue and helps maintain context. -### 7. Sign the Contributor License Agreement (CLA) +### 8. Sign the Contributor License Agreement (CLA) Before we can merge your contribution, you must sign our contributor license agreement (CLA). This agreement ensures that your contributions comply with our licensing terms. -### 8. Assign a Reviewer from Our Team +### 9. Assign a Reviewer from Our Team Once your PR is submitted, a member of our team will be assigned to review your changes. They will provide feedback and may request revisions if necessary. Please respond promptly to any review comments to expedite the merging process. -Thank you for contributing to our documentation! We appreciate your efforts in making our product documentation more comprehensive and user-friendly. If you have any questions or need assistance, feel free to reach out to our team. Happy contributing! \ No newline at end of file +Thank you for contributing to our documentation! We appreciate your efforts in making our product documentation more comprehensive and user-friendly. If you have any questions or need assistance, feel free to reach out to our team. Happy contributing! From 9c3ab04e6b779087d61649c5afe66dc469b084f2 Mon Sep 17 00:00:00 2001 From: Aaron Heckmann Date: Tue, 8 Jul 2025 17:36:03 -0700 Subject: [PATCH 2/4] fix: broken links --- self-hosting/govern/github-oauth.mdx | 1 - self-hosting/govern/google-oauth.mdx | 4 +--- self-hosting/methods/airgapped-edition.mdx | 2 +- 3 files changed, 2 insertions(+), 5 deletions(-) diff --git a/self-hosting/govern/github-oauth.mdx b/self-hosting/govern/github-oauth.mdx index 096268d5..f5e141de 100644 --- a/self-hosting/govern/github-oauth.mdx +++ b/self-hosting/govern/github-oauth.mdx @@ -25,6 +25,5 @@ Plane also supports GitHub OAuth so your users can sign-in with GitHub instead. 1. Go to `GitHub` on the Authentication screen of `/god mode`. 2. Add the client ID + the client secret from the GitHub app you just registered. 3. Click `Save `. -![](/images/instance-admin/authentication-instance-settings.png) Your Plane instance should now work with GitHub sign-in. diff --git a/self-hosting/govern/google-oauth.mdx b/self-hosting/govern/google-oauth.mdx index e275bdba..8f1183b3 100644 --- a/self-hosting/govern/google-oauth.mdx +++ b/self-hosting/govern/google-oauth.mdx @@ -29,10 +29,8 @@ First, you will need to identify Plane as an approved OAuth app to Google. 1. Go to `Google` on the Authentication screen of `/god mode`. 2. Add the client ID + the client secret from Google API Console. 3. Click `Save `. -![](/images/instance-admin/authentication-instance-settings.png) - Your Plane instance should now work with `Sign in with Google`. -We don't restrict domains in with Google OAuth yet. It's on our roadmap. \ No newline at end of file +We don't restrict domains in with Google OAuth yet. It's on our roadmap. diff --git a/self-hosting/methods/airgapped-edition.mdx b/self-hosting/methods/airgapped-edition.mdx index 29844818..d5f4844e 100644 --- a/self-hosting/methods/airgapped-edition.mdx +++ b/self-hosting/methods/airgapped-edition.mdx @@ -165,7 +165,7 @@ Once your air-gapped installation is running, you'll need to activate your works You should have received the `license_key.json` file as part of your air-gapped package. If you don't have this file, contact our support team. -1. Go to your [Workspace Settings](/core-concepts/workspaces/overview#workspace-settings) in the Plane application. +1. Go to your [Workspace Settings](https://docs.plane.so/core-concepts/workspaces/overview#workspace-settings) in the Plane application. 2. Select **Billing and plans** on the right pane. 3. Click the **Activate this workspace** button. ![Upload license file](/images/activate-license/upload-airgapped-license-file.webp) From f31c6d452b3100aab3ce8c31d12627aec9d06577 Mon Sep 17 00:00:00 2001 From: Aaron Heckmann Date: Tue, 8 Jul 2025 17:36:18 -0700 Subject: [PATCH 3/4] chore: check for broken links during CI --- .github/workflows/ci.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..94ef4649 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,32 @@ +name: CI +on: pull_request + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + ci: + name: Test + runs-on: ubuntu-latest + timeout-minutes: 15 + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 2 + + - name: Set up Node.js + uses: actions/setup-node@v4 + with: + node-version: '22' + + - name: Check for broken links + run: | + set -e + output=$(npx mint broken-links) + echo "$output" + if ! echo "$output" | grep -q '^success '; then + echo "Error: Broken links found! Fix the broken links listed above before merging." + exit 1 + fi From a0ebd8b1c8b5338510892085120d3a6ae5a89018 Mon Sep 17 00:00:00 2001 From: Aaron Heckmann Date: Tue, 8 Jul 2025 17:45:48 -0700 Subject: [PATCH 4/4] docs: fix contributing guide --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9a40477..51e6954d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,10 +29,10 @@ Make sure you are visually happy with your changes. 1. Run `npx mint broken-links` 2. Fix all reported broken links -### 5. Raise a Pull Request (PR) +### 6. Raise a Pull Request (PR) Once your changes are ready, raise a pull request (PR) to merge your branch into the `master` branch. Please provide a descriptive title and detailed description of your changes. -### 6. Leave a Clear Commit Message +### 7. Leave a Clear Commit Message When committing your changes, leave a clear and concise message that links to the corresponding issue (if applicable) and explains the fix or enhancement you've made. ```bash @@ -40,13 +40,13 @@ git add . git commit -m "Fixes #: Description of the fix or enhancement" ``` -### 7. Link the Issue to the Pull Request +### 8. Link the Issue to the Pull Request In your pull request description, be sure to reference the related issue using GitHub's syntax (`#`). This links the PR to the issue and helps maintain context. -### 8. Sign the Contributor License Agreement (CLA) +### 9. Sign the Contributor License Agreement (CLA) Before we can merge your contribution, you must sign our contributor license agreement (CLA). This agreement ensures that your contributions comply with our licensing terms. -### 9. Assign a Reviewer from Our Team +### 10. Assign a Reviewer from Our Team Once your PR is submitted, a member of our team will be assigned to review your changes. They will provide feedback and may request revisions if necessary. Please respond promptly to any review comments to expedite the merging process. Thank you for contributing to our documentation! We appreciate your efforts in making our product documentation more comprehensive and user-friendly. If you have any questions or need assistance, feel free to reach out to our team. Happy contributing!