-
Notifications
You must be signed in to change notification settings - Fork 28
Add ttl example #533
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
Add ttl example #533
Conversation
aversey
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some changes are to be made. Overall, I don't think the structure of "a bunch of examples" works well here. There is clearly a single main example and then a bit of information on how to update a TTL value of an existing FG. The main example itself is also too abstract to be relatable; it is better to use a concrete, simple FG instead. I would also try to summarize the goal of TTL usage in the example (to save resources or to simplify the usage of the FG) and state that it is achieved by following the guide/example. A user guide should show a user exactly how to achieve something useful for them; for easier searching, the useful effect of the guide should be stated explicitly.
kennethmhc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The original intend is to create example for TTL as requested by Ray. But I can extend it to include the use cases.
* add ttl example * update doc * fix style * separate line * indent code block --------- Co-authored-by: Aleksey Veresov <[email protected]>
* Add ttl example (#533) * add ttl example * update doc * fix style * separate line * indent code block --------- Co-authored-by: Aleksey Veresov <[email protected]> * fix link * fix mkdocs test --------- Co-authored-by: Aleksey Veresov <[email protected]>
No description provided.