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

[DOP-21387] Rebuild documentation structure #108

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Conversation

dolfinus
Copy link
Member

@dolfinus dolfinus commented Nov 14, 2024

Change Summary

  • Added docs/quickstart section with instruction how run all Data.Rentgen components in just one command, and how to connect Spark & Airflow to Kafka.
  • Added docs/entities page describing all entities in Data.Rentgen, and their relations.
  • Renamed docs/backend to docs/reference. For each section, like docs/reference/server, docs/reference/consumer, move installation instruction to index.rst, and rewrite it a bit.
  • Added docs/reference/database section describing how to run PostgreSQL (with and without docker). Moved here instruction how to run migrations and create partitions (previously this was described twice, in server and in consumer docs). Added note that partition creation script should be run on schedule.
  • Added docs/reference/broker section describing how to run Kafka.
  • Added frontend container to docker-compose.yml and docs/reference/frontend describing how to start and configure it.

It's a bit hard to read the diff, please see https://data-rentgen--108.org.readthedocs.build/en/108/

Related issue number

Checklist

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

Copy link

codecov bot commented Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.36%. Comparing base (68a1ac6) to head (1c2c4ce).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #108   +/-   ##
========================================
  Coverage    92.36%   92.36%           
========================================
  Files          154      154           
  Lines         3355     3355           
  Branches       227      227           
========================================
  Hits          3099     3099           
  Misses         199      199           
  Partials        57       57           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.rst Show resolved Hide resolved
docs/quickstart/setup_spark.rst Outdated Show resolved Hide resolved
@dolfinus dolfinus merged commit da6eb4e into develop Nov 15, 2024
10 checks passed
@dolfinus dolfinus deleted the feature/DOP-21387 branch November 15, 2024 14:06
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.

2 participants