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 docs #88

Merged
merged 33 commits into from
Jul 18, 2024
Merged

Update docs #88

merged 33 commits into from
Jul 18, 2024

Conversation

turtleDev
Copy link
Contributor

@turtleDev turtleDev commented Jul 12, 2024

Changes

  • run the docs through a grammer check

  • Add syntax highlighting for Code Examples

  • replace all references to "raystack.gitbook.io" with site-local refs

  • fix links in Usage section of the homepage

  • remove markup symbols from Overview section of Guide with hyperlinks

  • update topic name code in snippets to fix a bug with static topic names

  • fix broken roadmap link

  • reformat/rewrite:

    • Guides > Publishing Events > Data Formatters > Protos
    • Guides > Publishing Events > gRPC
    • Concepts > Architecture > Event Distribution
    • Guides > Troubleshooting > Publisher.
    • Guides > Monitoring
  • Add information about raccoon headers to kafka config map conversion.

  • under Concepts > Structure > Code Map

    • rename http to "services"
    • in workers, mention that publishers are abstracted and are no longer tightly coupled
    • in publishers: mention all supported publishers
  • add client examples in quickstart

    • go
    • java
    • js
    • CLI
  • Add instructions for setting up prometheus as metrics collector in Guides > Deployment

  • update deployment manifest in deployment guide

    • add config for enabling prometheus metrics
    • update raccoon pod manifest to include annotations necessary for raccoon prometheus integration
    • explain why the complicated k8s setups is necessary for prometheus (kubernetes_sd_config)
  • under Concepts > Architecture > Components

    • add information about Prometheus
    • add information about various publishers available in Raccoon
  • Replace mentions of Kafka with Publishers.

  • under Reference > Configurations add a separate header for each publisher

  • rewrote Contribute > Release Process with goreleaser and ci in mind

  • fix go client tests failing

  • fix broken go client (Go client installation fails due to error fetching proton module #86)

  • add a docker compose for quickstart so that users don't need to setup kafka

Changes Not Undertaken:

  • update Diagram in Introduction page with various publishers
  • update diagram to abstract out publisher at Concepts > Architecture > System Design
  • fixing java client pipeline

@ravisuhag ravisuhag merged commit 3e5bc0a into main Jul 18, 2024
11 checks passed
@ravisuhag ravisuhag deleted the update-docs branch July 18, 2024 03:14
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