docs
docs copied to clipboard
feat: celestia-app docker document
Overview
Checklist
- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or documentation updates
- [x] Linked issues closed with keywords
Summary by CodeRabbit
-
Documentation
- Expanded
docker-images.md
with comprehensive setup instructions for Celestia-App and Celestia-Node using Docker, featuring new sections, detailed steps, prerequisites, quick-start guides, and troubleshooting information.
- Expanded
what OS have you tested this on @ogunleye0720 ?
what OS have you tested this on @ogunleye0720 ?
Linux
- [ ] this pr needs to pass linting and formatting rules with
yarn lint
andyarn format
[] this pr needs to pass linting and formatting rules with
yarn lint
andyarn format
Okay, @jcstein I'm new to opensource. Thanks for pointing this out, I'll work on it.
no worries! thank you. note for myself too :)
i'll also be testing this on mac for final review
Walkthrough
The update significantly enhances the documentation for Celestia, specifically for running Celestia App and Celestia Node using Docker. It transforms the previous instructions into a comprehensive guide with structured sections, detailed prerequisites, quick-start instructions, and troubleshooting tips, all aimed at simplifying the setup and management of Celestia components in Docker environments.
Changes
File Path | Change Summary |
---|---|
nodes/docker-images.md |
Expanded to provide a comprehensive guide for setting up Celestia-App and Celestia-Node with detailed instructions, prerequisites, and troubleshooting information. Includes a Table of Contents and new sections like "Flag Breakdown." |
Poem
In the vast digital sky so bright, 🌌
Celestia nodes, a wondrous sight.
With Docker's help, they take their flight,
Through documentation clear and light.
A rabbit hops with sheer delight,
For blockchain worlds that shine so bright. 🚀
"To the moon!" it cries into the night. 🐰✨
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?
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.
-
@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 as 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.
Additionally, you can add @coderabbitai ignore
anywhere in the PR description to prevent this PR from being reviewed.
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.
gm @ogunleye0720 I apologize for the delay here. can you please work this into the existing docker page, into a section for celestia-app? instead of a new docker page? thanks!
checking in here @ogunleye0720
checking in here @ogunleye0720
Hello Justein, sorry for the late response. We are experiencing an internet outage here in Africa caused by a subsea cable break. I would start working on this today.
let's combine this with the existing docker page https://docs.celestia.org/nodes/docker-images
let's combine this with the existing docker page https://docs.celestia.org/nodes/docker-images
Apologies, I thought i was on the other repository. I have issues setting up Markdownlint on the https://docs.celestia.org/nodes/docker-images repository. Can you help me with any resource on how to set that up ?
this is all in the same repository. i'm just suggesting that you move the contents of the new page that you have to the existing page https://docs.celestia.org/nodes/docker-images which can be found in this repo under /nodes/docker-images.md
don't worry about markdown lint for now, but you can set it up with https://github.com/markdownlint/markdownlint and be sure to just lint the docs themselves, else you will see a lot of linting errors in node_modules
don't worry about markdown lint for now, but you can set it up with https://github.com/markdownlint/markdownlint and be sure to just lint the docs themselves, else you will see a lot of linting errors in node_modules
So this is what I have done so far, after some reviews, I was asked to some adjustments and make sure it's properly linted. https://github.com/ogunleye0720/celestia-app/tree/celestia-app-docker/docker
awesome! thank you for the context. let's please now add your new additions the existing docker page, so that both celestia-app and celestia-node for docker live in the same page https://docs.celestia.org/nodes/docker-images
TODO
- [ ] combine the new page in this PR with the existing docker page, so that there is only one page for docker for both celestia-node and celestia-app at
docker-images.md
TODO
- [ ] combine the new page in this PR with the existing docker page, so that there is only one page for docker for both celestia-node and celestia-app at
docker-images.md
On it 🫡
Don't we need to remove nodes/celestia-app-docker-image.md
still?
Don't we need to remove
nodes/celestia-app-docker-image.md
still?
Done @jcstein I have created a pull request.
gm @ogunleye0720 do you want to clean this up and get it merged?