Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Control Plane link #1617

Merged
merged 1 commit into from
May 14, 2024
Merged

Update Control Plane link #1617

merged 1 commit into from
May 14, 2024

Conversation

samueldemoura
Copy link
Contributor

@samueldemoura samueldemoura commented May 14, 2024

Very minor change - links to our page on the Control Plane website (which has info about our cpl tool and services) rather than the regular homepage.


This change is Reviewable

Summary by CodeRabbit

@samueldemoura samueldemoura self-assigned this May 14, 2024
Copy link
Contributor

coderabbitai bot commented May 14, 2024

Walkthrough

The primary change involves updating a hyperlink in the README.md file. The URL for ControlPlane has been altered from "https://controlplane.com" to "https://shakacode.controlplane.com" to reflect a new or updated link for a company that supports open source projects.

Changes

File Change Summary
README.md Updated hyperlink from "https://controlplane.com" to "https://shakacode.controlplane.com"

In the land of code where hyperlinks flow,
A rabbit hops where updates grow.
With URLs changed, the links now shine,
From ControlPlane to Shaka's line.
Hopping through the README, swift and bright,
Bringing clarity with every byte.
🌐✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Out of diff range and nitpick comments (18)
README.md (18)

Line range hint 21-21: Consider adding a determiner for clarity.

- * Project is updated to support Rails 7 and Shakapacker v6+!
+ * The project is updated to support Rails 7 and Shakapacker v6+!

Line range hint 45-45: Use a hyphen for compound adjectives.

- To provide a high performance framework for integrating Ruby on Rails with React via the [**Webpacker**](https://github.com/rails/webpacker) gem, especially regarding React Server-Side Rendering for better SEO and improved performance.
+ To provide a high-performance framework for integrating Ruby on Rails with React via the [**Webpacker**](https://github.com/rails/webpacker) gem, especially regarding React Server-Side Rendering for better SEO and improved performance.

Line range hint 53-53: Add a comma for clarity.

- Easy passing of props directly from your Rails view to your React components rather than having your Rails view load and then make a separate request to your API.
+ Easy passing of props directly from your Rails view to your React components, rather than having your Rails view load and then make a separate request to your API.

Line range hint 54-54: Use the possessive determiner "its".

- Tight integration with [shakapacker](https://github.com/shakacode/shakapacker) (or it's predecessor [rails/webpacker](https://github.com/rails/webpacker)).
+ Tight integration with [shakapacker](https://github.com/shakacode/shakapacker) (or its predecessor [rails/webpacker](https://github.com/rails/webpacker)).

Line range hint 57-57: Ensure all list items are properly formatted.

- [Automated optimized entry-point creation and bundle inclusion when placing a component on a page. With this feature, you no longer need to configure `javascript_pack_tags` and `stylesheet_pack_tags` on your layouts based on what’s shown. “It just works!”](https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation/)
+ [Automated optimized entry-point creation and bundle inclusion when placing a component on a page. With this feature, you no longer need to configure `javascript_pack_tags` and `stylesheet_pack_tags` on your layouts based on what’s shown. “It just works!”](https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation/)

Line range hint 60-60: Ensure all list items are properly formatted.

- [ReScript Support](https://github.com/shakacode/rescript-react-on-rails-example).
+ [ReScript Support](https://github.com/shakacode/rescript-react-on-rails-example).

Line range hint 72-72: Avoid split infinitives for better readability.

- [How to conditionally render server side based on the device type](https://forum.shakacode.com/t/how-to-conditionally-render-server-side-based-on-the-device-type/1473)
+ [How to render server side conditionally based on the device type](https://forum.shakacode.com/t/how-to-conditionally-render-server-side-based-on-the-device-type/1473)

Line range hint 81-81: Ensure all list items are properly formatted.

- [**Subscribe**](https://app.mailerlite.com/webforms/landing/l1d9x5) for announcements of new releases of React on Rails and of our latest [blog articles](https://blog.shakacode.com) and tutorials.
+ * [**Subscribe**](https://app.mailerlite.com/webforms/landing/l1d9x5) for announcements of new releases of React on Rails and of our latest [blog articles](https://blog.shakacode.com) and tutorials.

Line range hint 82-82: Ensure all list items are properly formatted.

- [Discussions](https://github.com/shakacode/react_on_rails/discussions): Post your questions regarding React on Rails
+ * [Discussions](https://github.com/shakacode/react_on_rails/discussions): Post your questions regarding React on Rails

Line range hint 83-83: Ensure all list items are properly formatted.

- **[forum.shakacode.com](https://forum.shakacode.com)**: Other discussions
+ * **[forum.shakacode.com](https://forum.shakacode.com)**: Other discussions

Line range hint 101-101: Use a hyphen for compound adjectives.

- The following companies support our open source projects, and ShakaCode uses their products!
+ The following companies support our open-source projects, and ShakaCode uses their products!

Line range hint 27-27: Ensure proper heading levels.

- #### About
+ ## About

Line range hint 81-81: Ensure consistent list style.

- - [**Subscribe**](https://app.mailerlite.com/webforms/landing/l1d9x5) for announcements of new releases of React on Rails and of our latest [blog articles](https://blog.shakacode.com) and tutorials.
+ * [**Subscribe**](https://app.mailerlite.com/webforms/landing/l1d9x5) for announcements of new releases of React on Rails and of our latest [blog articles](https://blog.shakacode.com) and tutorials.

Line range hint 82-82: Ensure consistent list style.

- - [Discussions](https://github.com/shakacode/react_on_rails/discussions): Post your questions regarding React on Rails
+ * [Discussions](https://github.com/shakacode/react_on_rails/discussions): Post your questions regarding React on Rails

Line range hint 83-83: Ensure consistent list style.

- - **[forum.shakacode.com](https://forum.shakacode.com)**: Other discussions
+ * **[forum.shakacode.com](https://forum.shakacode.com)**: Other discussions

Line range hint 84-84: Ensure consistent list style.

- - **[@railsonmaui on Twitter](https://twitter.com/railsonmaui)**
+ * **[@railsonmaui on Twitter](https://twitter.com/railsonmaui)**

Line range hint 85-85: Ensure consistent list style.

- - *See [NEWS.md](https://github.com/shakacode/react_on_rails/tree/master/NEWS.md) for more notes over time.*
+ * *See [NEWS.md](https://github.com/shakacode/react_on_rails/tree/master/NEWS.md) for more notes over time.*

Line range hint 86-86: Ensure consistent list style.

- - See [Projects](https://github.com/shakacode/react_on_rails/tree/master/PROJECTS.md) using and [KUDOS](https://github.com/shakacode/react_on_rails/tree/master/KUDOS.md) for React on Rails. Please submit yours! Please edit either page or [email us](mailto:[email protected]) and we'll add your info. We also **love stars** as it helps us attract new users and contributors.
+ * See [Projects](https://github.com/shakacode/react_on_rails/tree/master/PROJECTS.md) using and [KUDOS](https://github.com/shakacode/react_on_rails/tree/master/KUDOS.md) for React on Rails. Please submit yours! Please edit either page or [email us](mailto:[email protected]) and we'll add your info. We also **love stars** as it helps us attract new users and contributors.
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 613dfe4 and 5d036c1.
Files selected for processing (1)
  • README.md (1 hunks)
Additional Context Used
LanguageTool (12)
README.md (12)

Near line 21: A determiner appears to be missing. Consider inserting it.
Context: ...://github.com/shakacode/shakapacker). * Project is updated to support Rails 7 and Shaka...


Near line 45: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...**. ## Project Objective To provide a high performance framework for integrating Ruby on Rails...


Near line 53: Possible missing comma found.
Context: ...ctly from your Rails view to your React components rather than having your Rails view load...


Near line 54: “It’s” is the contracted form of “it is”. Did you mean to use the possessive determiner “its”?
Context: ...//github.com/shakacode/shakapacker) (or it's predecessor [rails/webpacker](https://g...


Near line 57: Unpaired symbol: ‘[’ seems to be missing
Context: ...-automated-bundle-generation/) 1. Redux and [...


Near line 60: Unpaired symbol: ‘[’ seems to be missing
Context: ....com+depth%3Aall/). 1. [ReScript Support](https://github.com/shakacode/rescript-r...


Near line 72: Style-wise, it’s not ideal to insert an adverb (‘conditionally’) in the middle of an infinitive construction (‘to render’). Try moving the adverb to avoid split infinitives.
Context: ...lient-and-server-rendering/1352) * [How to conditionally render server side based on the device type](https://forum...


Near line 81: Unpaired symbol: ‘[’ seems to be missing
Context: ...YWQ3MzA2NGE1YWJjNmVlMGE). - [Subscribe](https://app.mailerlite.com/webforms/lan...


Near line 82: Unpaired symbol: ‘[’ seems to be missing
Context: ...acode.com) and tutorials. - [Discussions](https://github.com/shakacode/react_on_r...


Near line 83: Unpaired symbol: ‘[’ seems to be missing
Context: ... React on Rails - forum.shakacode.com: Other d...


Near line 101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...rs The following companies support our open source projects, and ShakaCode uses their prod...


Near line 101: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 7193 characters long)
Context: ...jects, and ShakaCode uses their products!

<a href="https://www.je...

Additional comments not posted (1)
README.md (1)

116-116: Update the Control Plane link to the specific page.

The link to the Control Plane website has been updated correctly to "https://shakacode.controlplane.com".

@justin808
Copy link
Member

@samueldemoura this needs to be updated for many other repos. Please make changes.

That being said, this also shouldn't be necessary per other discussions based on the page referrer.

@justin808 justin808 merged commit f450fb5 into master May 14, 2024
7 of 16 checks passed
@justin808 justin808 deleted the chore/update-cpln-links branch May 14, 2024 22:31
@samueldemoura
Copy link
Contributor Author

@justin808 Yep, I'm already on it. Unfortunately there's other blockers stopping pure referrer-based checking from working as of now, so while that's not fixed we're better off updating the links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants