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

Updating README.md and update images #1986

Merged
merged 5 commits into from
Oct 25, 2023
Merged

Conversation

znegrin
Copy link
Contributor

@znegrin znegrin commented Oct 24, 2023

Describe changes

I updated the README.md file, adding new images and removing the outdated ones.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • If I have added an integration, I have updated the integrations table and the corresponding website section.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.

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)
  • Other (add details above)

Signed-off-by: Zuri Negrin <zurinegrin@gmail.com>
@znegrin znegrin requested a review from strickvl October 24, 2023 15:38
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 24, 2023
@github-actions
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 15.9%, saving 54.61 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/header.png 144.41 KB 111.22 KB -23.0% View diff
docs/book/.gitbook/assets/intro-zenml-overview.png 199.13 KB 177.71 KB -10.8% View diff

221 images did not require optimisation.

README.md Outdated Show resolved Hide resolved
@strickvl strickvl changed the title Updating README.md Updating README.md and update images Oct 24, 2023
@strickvl strickvl added the internal To filter out internal PRs and issues label Oct 24, 2023
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.

nice! I have a few comments.

First, the banner headline is a bit outdated. It should be something like "ZenML abstracts the infrastructure complexity for ML Engineers without locking you into any vendor"

Second, this part of the README also needs an update.. it feels like its overloaded with information... maybe removing some things or restructuring might help?

image

Signed-off-by: Zuri Negrin <zurinegrin@gmail.com>
@znegrin
Copy link
Contributor Author

znegrin commented Oct 25, 2023

@htahir1 I just pushed some changes to the header:

  • Replaced the image with the new text.
  • Moved the header image to the top.
  • Changed the badges to make them more compact and changed the colors to our primary palette.
  • Removed some of the contents as requested.

@github-actions
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 23%, saving 33.50 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/header.png 145.88 KB 112.38 KB -23.0% View diff

222 images did not require optimisation.

Signed-off-by: Zuri Negrin <zurinegrin@gmail.com>
@znegrin znegrin force-pushed the docs/readme-visual-updates branch from 673ea66 to 0a10123 Compare October 25, 2023 10:28
@github-actions
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 23%, saving 33.50 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/header.png 145.88 KB 112.38 KB -23.0% View diff

222 images did not require optimisation.

@znegrin znegrin merged commit 0158785 into develop Oct 25, 2023
2 checks passed
@znegrin znegrin deleted the docs/readme-visual-updates branch October 25, 2023 10:33
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.

4 participants