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

Documentation improvements #1549

Merged
merged 4 commits into from
Sep 10, 2024
Merged

Conversation

MarcAstr0
Copy link
Collaborator

Description

Style improvements to the documentation and some revised texts to better understand some concepts.

Changes

Checks

  • Project Builds
  • Project passes tests and checks
  • Updated documentation accordingly

Copy link

what-the-diff bot commented Sep 6, 2024

PR Summary

  • Added a new read model class
    The website/docs/03_architecture/06_read-model.mdx file now includes information about a new class named CarPurchasesReadModel. This class contains different properties such as id, carModel, carOwner, and offers, for organizing car purchasing data.

  • Updated the read model documentation
    The read model documentation has received several updates for clarification and completeness. These additions include the behavior when a read model doesn't match a query, the use of read models for data validation, and more detailed instructions on read model filtering.

  • Improvements to query documentation
    An update to the website/docs/03_architecture/08_queries.mdx file reflects that query subscriptions are currently not available.

  • Updated GraphQL documentation
    Several updates have been made to the website/docs/06_graphql.md document. Notes on the limitations of selecting fields from objects within arrays, the usage of the select function for skipping read model migrations, and the use of read models for data validations have been added. Additionally, information on querying entities for up-to-date states, sorting, and pagination limitations has been incorporated.

  • Inserted note on EventStream functionality on Azure
    The document website/docs/10_going-deeper/azure-scale.mdx now mentions that EventStream functionality is only available for the Azure provider.

  • Amended sensor health documentation
    The website/docs/10_going-deeper/health/sensor-health.md file now clarifies that details will be included only if enabled and that rockets sensors are currently available only for the Azure provider.

  • Added warning and examples for removing events
    The website/docs/10_going-deeper/remove-events.mdx file now includes a warning about the experimental nature of the remove event functionality and its limited support, as well as an example of deleting a ReadModel, and a note about the irreversibility of changes from deleting events.

  • Updated contributing guidelines
    For the website/docs/12_contributing.md the project now contains a note about referencing related closed issues when creating a new issue, helping to keep context and history linked.

@MarcAstr0 MarcAstr0 marked this pull request as ready for review September 6, 2024 21:21
@MarcAstr0 MarcAstr0 added the documentation Improvements or additions to documentation label Sep 6, 2024
@MarcAstr0 MarcAstr0 merged commit c495c91 into boostercloud:main Sep 10, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants