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 docs following CLI change #255

Merged
merged 3 commits into from
Dec 21, 2021
Merged

Update docs following CLI change #255

merged 3 commits into from
Dec 21, 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

Updated docs to account for the switch from arguments to option flags in our 5 core components.

@alex-zenml alex-zenml added documentation Improvements or additions to documentation internal To filter out internal PRs and issues labels Dec 21, 2021
htahir1
htahir1 reviewed Dec 21, 2021
View reviewed changes
src/zenml/cli/__init__.py Outdated
@@ -169,7 +176,8 @@

.. code:: bash

zenml metadata-store register METADATA_STORE_NAME METADATA_STORE_TYPE [--OPTIONS]
zenml metadata-store register METADATA_STORE_NAME --type METADATA_STORE_TYPE
[--OPTIONS]
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm im wondering whether there should not be a new line here and down below? Might get rendered incorrectly and users might find it hard to copy paste

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I only made that change because I saw that there was a lot of that that took place in the cleanup. Happy to add in that fix, though.

@alex-zenml
Copy link
Contributor Author

@htahir1 fixed.

htahir1
htahir1 approved these changes Dec 21, 2021
View reviewed changes
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.

LGTM!

@alex-zenml alex-zenml merged commit fe4645f into main Dec 21, 2021
@alex-zenml alex-zenml deleted the alex/ENG-273-update-docs branch December 21, 2021 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@schustmi schustmi schustmi approved these changes

@htahir1 htahir1 htahir1 approved these changes

@AlexejPenner AlexejPenner Awaiting requested review from AlexejPenner

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation internal To filter out internal PRs and issues
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@alex-zenml @htahir1 @schustmi @strickvl