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

Add one-click deploy on sealos #7999

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

yangchuansheng
Copy link

@yangchuansheng yangchuansheng commented Mar 28, 2024

Change Summary

Provide summary of changes with issue number if any.

Change type

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Test/ Verification

Provide summary of changes.

Additional information / screenshots (optional)

Anything for maintainers to be made aware of

Summary by CodeRabbit

  • Documentation
    • Added Sealos deployment instructions for self-hosted installation guide, including a direct link for template deployment and detailed steps for registration and deployment process.

Signed-off-by: Carson Yang <yangchuansheng33@gmail.com>
Copy link
Contributor

coderabbitai bot commented Mar 28, 2024

Walkthrough

Walkthrough

The update introduces a new section dedicated to Sealos deployment instructions within the installation documentation. This addition provides users with a direct link to a prebuilt template deployment page, alongside detailed guidance on the registration and deployment process, making it easier for users to self-host the application using Sealos.

Changes

Files Change Summary
packages/noco-docs/docs/.../010.installation.md Added a section for Sealos deployment instructions, including a button link to a prebuilt template deployment page and guidance on the registration and deployment process.

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5109746 and ed3835f.
Files selected for processing (1)
  • packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation.md (1 hunks)
Additional comments (1)
packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation.md (1)
  • 428-441: The new section for Sealos deployment is well-integrated and follows the structure of other deployment sections in the document. Ensure the link provided is correct and that the instructions are complete for a smooth user experience.

Comment on lines 425 to 445

</details>

### Sealos

<details>
<summary>Click to Expand</summary>

Just click on the button below to be redirected to the Sealos prebuilt template deployment page:

[![](https://cdn.jsdelivr.net/gh/labring-actions/templates@main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dnocodb)

> Note: New users to [Sealos](https://sealos.io) must register and log in to proceed.

After clicking the ‘Deploy Application’ button, the deployment starts. Upon completion, click ‘Details’ on the application page. Subsequently, click on the external link to access the application's Web interface directly through the external domain name.

</details>

### Railway

<details>
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [11-11]

Consider removing the spaces before and after the greater than symbol in the Node.js version requirement for consistency with common formatting practices.

- Node.js](https://nodejs.org/en/download) ( > v18.x )
+ Node.js](https://nodejs.org/en/download) (>v18.x)

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [69-69]

In the tip about persisting data in Docker, consider adding a comma after "Otherwise" for better readability.

- Otherwise your data will be lost after recreating the container.
+ Otherwise, your data will be lost after recreating the container.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [200-200]

The section "Node Application" should refer to "Node.js Application" to maintain consistency with the official naming.

- Node Application
+ Node.js Application

@yangchuansheng
Copy link
Author

Preview:

After deploy:

@yangchuansheng
Copy link
Author

Please let me know if there's anything else I should work on or if you have any further feedback, thanks.

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.

None yet

2 participants