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.

Sign up for GitHub

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

Jump to bottom

Update customizable classes docs #11207

Merged
merged 7 commits into from
Jun 24, 2022
Merged

Update customizable classes docs #11207

merged 7 commits into from
Jun 24, 2022

Conversation

ancalita
Copy link
Member

@ancalita ancalita commented Jun 20, 2022 •
edited
Loading

Proposed changes:

  • Update docs about tracker stores, event brokers and lock stores.

Status (please check what you already did):

  • added some tests for the functionality
  • updated the documentation
  • updated the changelog (please check changelog for instructions)
  • reformat files using black (please check Readme for instructions)

@ancalita ancalita requested a review from indam23 June 20, 2022 16:27
@ancalita ancalita marked this pull request as ready for review June 20, 2022 16:28
indam23
indam23 suggested changes Jun 22, 2022
View reviewed changes
Copy link
Contributor

@indam23 indam23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

For methods required to be implemented, can we stick to one way of specifying signatures/return types and use it everywhere? Potentially a link to source code for each base class (in main probably?) could help people get started

docs/docs/event-brokers.mdx Outdated Show resolved Hide resolved
docs/docs/event-brokers.mdx Outdated Show resolved Hide resolved
docs/docs/lock-stores.mdx Outdated Show resolved Hide resolved
docs/docs/tracker-stores.mdx Outdated Show resolved Hide resolved
docs/docs/tracker-stores.mdx Outdated Show resolved Hide resolved
@ancalita ancalita requested a review from indam23 June 23, 2022 11:24
indam23
indam23 approved these changes Jun 24, 2022
View reviewed changes
Copy link
Contributor

@indam23 indam23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving with a suggestion to make the link text less redundant

docs/docs/event-brokers.mdx Outdated Show resolved Hide resolved
@ancalita ancalita enabled auto-merge (squash) June 24, 2022 13:29
@github-actions
Copy link
Contributor

🚀 A preview of the docs have been deployed at the following URL: https://11207--rasahq-docs-rasa-v2.netlify.app/docs/rasa

@ancalita ancalita merged commit f35d789 into 3.2.x Jun 24, 2022
@ancalita ancalita deleted the ATO-96-update-customizable-classes-tracker-stores-event-brokers-lock-stores-docs branch June 24, 2022 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@indam23 indam23 indam23 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ancalita @indam23