Skip to content
This repository has been archived by the owner on Aug 22, 2019. It is now read-only.

#1195 - add documentation on how to use different tracker stores #1198

Merged
merged 5 commits into from
Oct 31, 2018

Conversation

wochinge
Copy link
Contributor

@wochinge wochinge commented Oct 19, 2018

Motivation:

Proposed changes:

  • Added a subsection within the developer section which informs about the currently existing tracker store types and how to configure them
  • Added a subsection within the developer section which explains how to implement a custom tracker store.

Status (please check what you already did):

@wochinge wochinge added the docs label Oct 19, 2018
@wochinge wochinge requested a review from JustinaPetr October 19, 2018 12:53
@wochinge
Copy link
Contributor Author

Is it required to update the changelog for changes in the documentation?

user: <username used for authentication>
password: <password used for authentication>

3. To start the Rasa Core server using your configured Redis instance,

Choose a reason for hiding this comment

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

This should probably mean MongoDB instance instead of Redis instance?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! I updated the branch. Somehow it's not yet reflected in Github.

@wochinge wochinge force-pushed the tracker_store_documentation branch 3 times, most recently from cf22f01 to 818ece4 Compare October 22, 2018 07:33
Copy link

@JustinaPetr JustinaPetr left a comment

Choose a reason for hiding this comment

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

Looks great @wochinge. Really good job with including the actual setps of implementation - it's a very common request from our community and makes it a lot easier to understand how the feature should be implemented.

@souvikg10
Copy link
Contributor

Note from the #1048 , the endpoints.yml documentation needs to be updated.

timeout is replaced by record_exp

@wochinge wochinge force-pushed the tracker_store_documentation branch from 818ece4 to 16f5d97 Compare October 26, 2018 14:45
@wochinge
Copy link
Contributor Author

Thanks for the hint, but I haven't included the timeout in the examples I made (guess I always assumed the default values). But I think it is a good idea to add a description of each possible parameter for each tracker store.

@wochinge wochinge force-pushed the tracker_store_documentation branch from 16f5d97 to b82cd52 Compare October 30, 2018 14:31
@wochinge wochinge force-pushed the tracker_store_documentation branch from b82cd52 to 3bc07d3 Compare October 30, 2018 14:36
@wochinge
Copy link
Contributor Author

@JustinaPetr Can you have one more quick look. I added a section which lists the possible parameters for each TrackerStore.

@JustinaPetr
Copy link

Looks good @wochinge.

@wochinge wochinge merged commit 95e430f into master Oct 31, 2018
@wochinge wochinge deleted the tracker_store_documentation branch October 31, 2018 13:33
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants