Relative links don't work with Shakacode website. #246

Judahmeek · 2024-12-07T20:20:20Z

Summary by CodeRabbit

Documentation
- Updated links in the README.md for better accessibility to migration resources for Postgres and Redis databases.
- All links now direct to full URLs, ensuring users can easily access the correct documentation regardless of their location in the repository.

coderabbitai · 2024-12-07T20:20:39Z

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request focus on updating links in the README.md file. The modifications involve replacing relative URLs with absolute URLs for various documentation resources, including migration guides for Postgres and Redis databases. This update enhances the accessibility of the documentation by ensuring users can access the correct resources directly, regardless of their location within the repository. The overall structure and content of the document remain unchanged.

Changes

File	Change Summary
README.md	Updated links for migrating Postgres, Redis databases, tips, and other documentation to full URLs.

Possibly related PRs

feat: documentation updates to support MDX syntax to be usable on Shakacode's website #234: The changes in this PR also involve updates to the README.md file, specifically focusing on documentation improvements, which aligns with the main PR's updates to links in the same file.

Suggested reviewers

justin808
rafaelgomesxyz

Poem

In the land of code where rabbits play,
Links were broken, leading astray.
With a hop and a click, they found their way,
To full URLs brightening the day!
Now documentation shines, clear as can be,
A joyful leap for all to see! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 67d8f35 and 58b3c9e.

📒 Files selected for processing (1)

README.md (5 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

zzaakiirr · 2024-12-10T07:06:13Z

@Judahmeek We also have relative links to images in docs/tips.md, I can't see them in shakacode website, could you fix them too?

GitHub

ShakaCode

zzaakiirr

See comment about relative asset links

zzaakiirr · 2024-12-10T07:18:25Z

README.md

-14. [Migrating Postgres Database from Heroku Infrastructure](/docs/postgres.md)
-15. [Migrating Redis Database from Heroku Infrastructure](/docs/redis.md)
-16. [Tips](/docs/tips.md)
+14. [Migrating Postgres Database from Heroku Infrastructure](https://github.com/shakacode/control-plane-flow/docs/postgres.md)


Here and in similar places
This link returns Not Found response - branch name should be specified

Suggested change

14. [Migrating Postgres Database from Heroku Infrastructure](https://github.com/shakacode/control-plane-flow/docs/postgres.md)

14. [Migrating Postgres Database from Heroku Infrastructure](https://github.com/shakacode/control-plane-flow/tree/main/docs/postgres.md)

@Judahmeek We need to figure out how to make relative links work for this repo like they do for https://github.com/shakacode/react_on_rails.

@justin808 The ReactOnRails repository has NO relative links.

You & I got rid of them (because they don't work cross-domain) a long time ago.

Judahmeek · 2024-12-17T21:37:57Z

@zzaakiirr The image issue is something that will have to be fixed in the sc-website repository.

Also, I've updated the links to point to the Shakacode website, similar to ReactOnRails doc links.

Please sanity check real quick. 😅

zakir-dzhamaliddinov

It's not related to relative links problem, maybe it's better to open another PR for this fix 🤔 - can we also fix link on line 482?

It should be https://docs.controlplane.com/reference/workload/types#cron i/o https://shakadocs.controlplane.com/reference/workload#cron

zzaakiirr

See #246 (review)

Judahmeek requested a review from zzaakiirr December 7, 2024 20:24

zzaakiirr approved these changes Dec 10, 2024

View reviewed changes

zzaakiirr requested changes Dec 10, 2024

View reviewed changes

zzaakiirr reviewed Dec 10, 2024

View reviewed changes

zzaakiirr mentioned this pull request Dec 10, 2024

Terraform docs: fix relative links #247

Open

corrected links

67d8f35

Judahmeek force-pushed the Judahmeek-patch-1 branch from d0572ff to 67d8f35 Compare December 17, 2024 21:42

Judahmeek requested a review from zzaakiirr December 17, 2024 21:46

zakir-dzhamaliddinov approved these changes Dec 18, 2024

View reviewed changes

zzaakiirr approved these changes Dec 18, 2024

View reviewed changes

update link for cron job documentation

58b3c9e

Judahmeek merged commit 5d392e7 into main Dec 18, 2024
4 of 5 checks passed

Judahmeek deleted the Judahmeek-patch-1 branch December 18, 2024 21:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Relative links don't work with Shakacode website. #246

Relative links don't work with Shakacode website. #246

Judahmeek commented Dec 7, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 7, 2024 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

zzaakiirr commented Dec 10, 2024

zzaakiirr left a comment

zzaakiirr Dec 10, 2024

justin808 Dec 12, 2024

Judahmeek Dec 17, 2024 •

edited

Loading

Judahmeek commented Dec 17, 2024 •

edited

Loading

zakir-dzhamaliddinov left a comment

zzaakiirr left a comment

	14. [Migrating Postgres Database from Heroku Infrastructure](https://github.com/shakacode/control-plane-flow/docs/postgres.md)
	14. [Migrating Postgres Database from Heroku Infrastructure](https://github.com/shakacode/control-plane-flow/tree/main/docs/postgres.md)

Relative links don't work with Shakacode website. #246

Relative links don't work with Shakacode website. #246

Conversation

Judahmeek commented Dec 7, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Dec 7, 2024 • edited Loading

Review failed

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

zzaakiirr commented Dec 10, 2024

zzaakiirr left a comment

Choose a reason for hiding this comment

zzaakiirr Dec 10, 2024

Choose a reason for hiding this comment

justin808 Dec 12, 2024

Choose a reason for hiding this comment

Judahmeek Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

Judahmeek commented Dec 17, 2024 • edited Loading

zakir-dzhamaliddinov left a comment

Choose a reason for hiding this comment

zzaakiirr left a comment

Choose a reason for hiding this comment

Judahmeek commented Dec 7, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 7, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

Judahmeek Dec 17, 2024 •

edited

Loading

Judahmeek commented Dec 17, 2024 •

edited

Loading