Skip to content

Conversation

SaeeDawod
Copy link
Contributor

@SaeeDawod SaeeDawod commented Apr 9, 2024

added the content of this file to the doc https://docs.google.com/document/d/1su3-38HWsPBEV7quiDEY4MBHdEWKvyzwEKTNIqTRkWE/edit

created a "legacy" folder in the docs with the old installation docs

Summary by CodeRabbit

  • New Features
    • Updated labels for better clarity in the platform documentation.
    • Added new files introducing installation guides and prerequisites for the SettleMint Blockchain Transformation Platform (BTP).
    • Provided comprehensive guides for trial installations on managed Kubernetes clusters.
    • Included instructions for running the installation using a Helm chart.
    • Added support and troubleshooting documentation for platform installation.

Copy link

coderabbitai bot commented Apr 9, 2024

Walkthrough

The changes focus on refining the documentation for deploying the SettleMint Blockchain Transformation Platform on Kubernetes. Updates include renaming categories, introducing new guides for installation and prerequisites, and enhancing support and troubleshooting instructions.

Changes

Files Summary
docs/launch-platform/self-hosted/_category_.json Update label to "Self Hosted Deployment"
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/_category_.json Update label to "Installation Guide"
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/introduction.md Introduce BTP Installation Guide
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/... Introduce Legacy category with position adjustments
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/... Introduce Infrastructure and Partner guidance
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/... Introduce Quick Start Examples & Trial Installations
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md Guide on running SettleMint Platform installation
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/support-and-roubleshooting.md Guidance on support and troubleshooting

Poem

Amidst the code and JSON dance,
SettleMint's guide gets a chance.
Categories shift, new paths unfold,
Rabbit whispers, tales untold.
Troubleshoot woes, with a hop and a glance. 🐰✨

Note

Pull Request Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://coderabbit.ai.


Commits Files that changed from the base of the PR and between 350275d and 48516c7.
Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
Files selected for processing (18)
  • docs/launch-platform/self-hosted/category.json (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/category.json (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/introduction.md (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/category.json (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/category.json (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/category.json (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-online/category.json (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/requirements.md (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure.md (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/category.json (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/choosing-a-partner.md (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/category.json (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-cluster.md (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-embedded.md (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-kots.md (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-remote.md (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md (1 hunks)
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/support-and-roubleshooting.md (1 hunks)

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.

@github-actions github-actions bot added the feat New feature label Apr 9, 2024
@roderik roderik merged commit cd3eb54 into main Apr 9, 2024
@roderik roderik deleted the feat/docs-update-for-btp branch April 9, 2024 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat New feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants