feat: add otel collector section for mocha, and headings. also linting and fix internal link

[jcstein]

Overview

This PR adds a section to otel collector for mocha. Needs to be updated with:

• placeholder URL for otel collector for mocha
• the correct URL for otel collector using placeholder in meantime to get these changes in

There is a known issue with the preview link in comment from celestia-bot below (#1195). So Use this link for the preview of the relevant section

This PR also replaces https://github.com/celestiaorg/docs/pull/1398/files, switching to internal links for links internal pages on the site.

Separately, I think the linting should be in CI again IMO it is a PITA to deal with locally, opened up #1399 to track this issue. Update here, I'll be using a git commit hook instead of husky

Checklist

• New and updated code has appropriate documentation
• New and updated code has new and/or updated testing
• Required CI checks are passing
• Visual proof for any user facing features like CLI or documentation updates
• Linked issues closed with keywords

Summary by CodeRabbit

• Documentation
  • Refined the Celestia Foundation Delegation Program guidelines, including clearer objectives, application process, and eligibility criteria.
  • Added instructions and examples for integrating metrics flags into Celestia node start commands, including specifics for Mainnet Beta and Mocha testnet.

[coderabbitai]

Walkthrough

The recent updates focus on refining the Celestia Foundation Delegation Program, specifically targeting the improvement of validator participation guidelines and the node metrics monitoring process. These changes aim to enhance clarity, fairness, and performance in validator operations, while also providing detailed instructions for integrating metrics into Celestia nodes, ensuring better network monitoring and stability.

Changes

File Path	Change Summary
.../foundation-delegation-program.md	Refined objectives, detailed application process, eligibility, and undelegation criteria for validators.
.../celestia-node-metrics.md	Added metrics flag instructions, examples for Mainnet Beta and Mocha testnet, and endpoint requirements.

🐇✨
In the realm of nodes and validators wide,
Changes come on a swift, enlightening ride.
With metrics and guidelines finely tuned,
Celestia's foundation is now moon-bound. 🚀🌕

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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.
• 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 from git 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.

[github-actions]

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs/pr-preview/pr-1400/
on branch gh-pages at 2024-02-07 16:01 UTC

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e310332 and 4e4da1c.

Files selected for processing (2)

• community/foundation-delegation-program.md (3 hunks)
• nodes/celestia-node-metrics.md (2 hunks)

Additional comments: 6

nodes/celestia-node-metrics.md (3)

• 25-33: Ensure the placeholder URL for the metrics endpoint in the Mainnet Beta example is replaced with the correct URL once available.
• 51-52: Confirm the placeholder <your-mocha-metrics-endpoint> is intended for users to replace with their specific endpoint URL.
• 31-33: Verify the ADR link is accessible and points to the correct document.

community/foundation-delegation-program.md (3)

• 7-15: Ensure the objectives of the program are aligned with the Celestia Foundation's mission and accurately reflect the program's goals.
• 107-114: Review the undelegation criteria for clarity and ensure they are consistent with the Celestia Foundation's policies and legal requirements.
• 171-172: Confirm the frequency and content of the feedback form align with the program's objectives for continuous improvement.