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 #220

Merged
merged 20 commits into from
Dec 13, 2021
Merged

Update docs #220

merged 20 commits into from
Dec 13, 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 documentation 'above the fold' (in the top section) of the docs.
  • added a new 'features' section since otherwise it was getting a bit unwieldy (currently references the caching bit being written by @AlexejPenner but that doesn't exist yet)

@github-actions github-actions bot added the internal To filter out internal PRs and issues label Dec 13, 2021
@alex-zenml alex-zenml added the documentation Improvements or additions to documentation label Dec 13, 2021
htahir1
htahir1 approved these changes Dec 13, 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.

Cool just a few comments!

docs/book/index.md Show resolved Hide resolved
docs/book/integrations.md
![ZenML is the glue](assets/zenml-is-the-glue.jpeg)

These are the third-party integrations that ZenML currently supports:

Copy link
Contributor

Choose a reason for hiding this comment

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

Awesome section! I

docs/book/integrations.md Outdated

| Integration | Status | Implementation Notes |
| ------------------ | ------ | ------------------------------------------ |
| Apache Airflow | ✅ | Works for local environment |
Copy link
Contributor

Choose a reason for hiding this comment

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

One thing: Multiple integrations may have different dimensions. E.g. Airflow can be used only as an orchestrator but it has a dimension of being local or cloud. Similarly plotly, dash, and graphviz are visualizers integrations but only for Pipeline and PipelineRun visualization objects. Is there an idea in the room how to showcase what integrations actually do and what a tick means? Perhaps we can add a description column with a detailed description and links to what it is?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Like a kind of category? Yes I can do that.

@htahir1
Copy link
Contributor

htahir1 commented Dec 13, 2021

Lets merge it Alex!

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

@htahir1 htahir1 htahir1 approved these changes

@alexej-zenml alexej-zenml alexej-zenml approved these changes

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 @alexej-zenml @strickvl