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

Add reference docs for CLI example functionality #145

Merged
merged 4 commits into from
Oct 25, 2021

Conversation

alex-zenml
Copy link
Contributor

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to the documentation, I have updated the documentation accordingly.
  • I have added tests to cover my changes.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Describe changes

Added a section relating to the zenml example commands in the CLI reference docs
Added a todo in src relating to a bug I found in the example command functionality (relates to what happens when you do a new release).

@alex-zenml alex-zenml added documentation Improvements or additions to documentation internal To filter out internal PRs and issues labels Oct 25, 2021
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Cool! As a note I also put some of this information here: https://github.com/zenml-io/zenml/tree/main/examples

@htahir1 htahir1 merged commit 86e8e39 into main Oct 25, 2021
@htahir1 htahir1 deleted the alex/ENG-56-cli-docs-update branch October 25, 2021 13:18
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 internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants