Skip to content

Conversation

@snigdha920
Copy link
Contributor

@snigdha920 snigdha920 commented Dec 27, 2024

Builds without any broken links now:
CleanShot 2024-12-27 at 10 57 18@2x

Summary by Sourcery

Update documentation to reflect the use of access tokens instead of API keys and fix broken links.

Enhancements:

  • Updated code snippets to use access tokens instead of API keys.

Documentation:

  • Updated documentation to reflect the use of access tokens instead of API keys.
  • Fixed broken links in the documentation.
  • Clarified the supported cloud providers and regions and added contact information for unsupported regions.
  • Updated the prerequisites section to include links to relevant documentation.
  • Improved the troubleshooting section with more detailed instructions and commands.
  • Added a note about the limitations of the Terraform installation method.

Tests:

  • Fail the build if there are any broken links in the documentation.

@linear
Copy link

linear bot commented Dec 27, 2024

CUS-672 Fix broken markdown links in current documentation

snigdha saeed current docs give me these broken links

Warning: Docs markdown link couldn't be resolved: (19_api-keys.md) in "/home/runner/work/docs/docs/docs/using-platform/10_backend-as-a-service.md" for version current
Warning: Docs markdown link couldn't be resolved: (19_api-keys.md) in "/home/runner/work/docs/docs/docs/using-platform/10_backend-as-a-service.md" for version current
Warning: Docs markdown link couldn't be resolved: (19_application-access-tokens.md) in "/home/runner/work/docs/docs/docs/using-platform/21_personal-access-tokens.md" for version current
Warning: Docs markdown link couldn't be resolved: (19_application-access-tokens.md) in "/home/runner/work/docs/docs/docs/using-platform/21_personal-access-tokens.md" for version current
Warning: Docs markdown link couldn't be resolved: (./0_supported-cloud-providers.md) in "/home/runner/work/docs/docs/docs/using-platform/22_deployment-plans.md" for version current
Warning: Docs markdown link couldn't be resolved: (./0_supported-cloud-providers.md) in "/home/runner/work/docs/docs/docs/using-platform/22_deployment-plans.md" for version current
Warning: Docs markdown link couldn't be resolved: (19_api-keys.md) in "/home/runner/work/docs/docs/docs/using-platform/9_integration-studio.md" for version current
Warning: Docs markdown link couldn't be resolved: (19_api-keys.md) in "/home/runner/work/docs/docs/docs/using-platform/9_integration-studio.md" for version current

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 27, 2024

Reviewer's Guide by Sourcery

This pull request fixes broken links in the documentation and implements a build check to prevent future broken links.

State diagram for documentation link validation

stateDiagram-v2
    [*] --> CheckingLinks
    CheckingLinks --> LinksValid: All links valid
    CheckingLinks --> LinksInvalid: Broken links found
    LinksValid --> BuildSuccess: Continue build
    LinksInvalid --> BuildFailure: Halt build
    BuildSuccess --> [*]
    BuildFailure --> [*]
Loading

File-Level Changes

Change Details Files
Updated broken links across documentation pages.
  • Replaced outdated links with correct ones.
  • Corrected references to API keys and access tokens.
  • Fixed relative links within the documentation to ensure proper navigation.
docs/using-platform/9_integration-studio.md
docs/using-platform/10_backend-as-a-service.md
docs/using-platform/21_personal-access-tokens.md
docs/launch-platform/self-hosted/installation-guide/platform-installation.md
docs/launch-platform/self-hosted/installation-guide/prerequisites/terraform.md
docs/launch-platform/managed-cloud-deployment/0_supported-cloud-providers.md
docs/launch-platform/managed-cloud-deployment/13_deployment-plans.md
docs/using-platform/22_deployment-plans.md
Fixed formatting issues in code examples and lists.
  • Improved code formatting for better readability.
  • Corrected formatting inconsistencies in lists and code blocks.
  • Ensured consistent use of double quotes in code examples.
docs/using-platform/9_integration-studio.md
docs/launch-platform/self-hosted/installation-guide/prerequisites/terraform.md
Implemented a build check for broken links.
  • Added configuration to fail the build process if broken links are detected.
  • Changed onBrokenLinks and onBrokenMarkdownLinks from warn to throw to enforce the check during build time.
docusaurus.config.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the fix Bug fix label Dec 27, 2024
@snigdha920 snigdha920 changed the title fix: all broken links fix: all broken links, fail build if broken links Dec 27, 2024
@snigdha920 snigdha920 marked this pull request as ready for review December 27, 2024 10:04
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @snigdha920 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@roderik roderik merged commit cc8ae70 into main Dec 27, 2024
3 checks passed
@roderik roderik deleted the snigdha/cus-672-fix-broken-markdown-links-in-current-documentation branch December 27, 2024 11:54
snigdha920 added a commit that referenced this pull request Dec 29, 2024
…-current-documentation

* main:
  chore(deps): update dependency @fontsource/figtree to v5.1.2 (#113)
  fix: all broken links, fail build if broken links (#112)
  chore(config): migrate renovate config (#111)
  fix: remove atlassian
  fix: compilation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fix Bug fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants