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

Feat: Add a changelog section on hompage #1907

Open
wants to merge 9 commits into
base: prod
Choose a base branch
from

Conversation

thisisobate
Copy link
Contributor

@thisisobate thisisobate commented Dec 26, 2024

Todo

  • make the changelog section look nicer on mobile

Fixes #1851

@thisisobate
Copy link
Contributor Author

@frouioui

Copy link

netlify bot commented Dec 26, 2024

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 0b28b69
🔍 Latest deploy log https://app.netlify.com/sites/vitess/deploys/677c30ff4922e50008f619e6
😎 Deploy Preview https://deploy-preview-1907--vitess.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@deepthi
Copy link
Member

deepthi commented Dec 31, 2024

I like this! One suggestion I have though is not to use release blog posts in the changelog. Instead, can you use the following?

Copy link
Contributor

@shlomi-noach shlomi-noach left a comment

Choose a reason for hiding this comment

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

Nice! Thank you for working on this. I will echo @deepthi's comments. I also think we may as well retroactively generate some changelog entires based on Vitess changelog commits.

@thisisobate
Copy link
Contributor Author

thisisobate commented Dec 31, 2024

I also think we may as well retroactively generate some changelog entires based on Vitess changelog commits

Sweet! I imagine we will have to do some docs pre-processing to make this work? I don't know. We can always play around and improve this workflow. Let's do this in a separate PR if possible.

@deepthi
Copy link
Member

deepthi commented Jan 3, 2025

@thisisobate if you can accept the netlify invite I sent you, we won't need to manually approve deploy previews on your PRs.

@deepthi
Copy link
Member

deepthi commented Jan 3, 2025

I also think we may as well retroactively generate some changelog entires based on Vitess changelog commits

Sweet! I imagine we will have to do some docs pre-processing to make this work? I don't know. We can always play around and improve this workflow. Let's do this in a separate PR if possible.

We can handcraft the retroactive changelings, but I agree that should be a separate PR.

@deepthi
Copy link
Member

deepthi commented Jan 3, 2025

This looks great on web and tablet. On mobile (iPhone), it could be better if you can push the "view all changes" link to the right. Not sure why it isn't right justified on iPhone the way it is on iPad / Safari on web.
I hope you can fix this, once that is done we can go ahead and approve and merge this PR.

Vitess  Scalable  Reliable  MySQL-compatible  Cloud-native  Database

@thisisobate
Copy link
Contributor Author

ok..will fix right away

@thisisobate
Copy link
Contributor Author

@deepthi Fixed the layout issue on mobile

Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Left some comments and nits. This is really good and the web + mobile versions look good to me.

One comment, there is a lot of duplication between the changelog folder and the blog post folder. It would be nice if we can use symlink, or another system to avoid having to change two files in two different places when we need to edit a blog post.

I'll approve and not merge yet to allow @deepthi and @shlomi-noach to give more feedback.

@frouioui frouioui added the do-not-merge PR contains issues or is dependent on another task label Jan 6, 2025
@thisisobate
Copy link
Contributor Author

thisisobate commented Jan 6, 2025

It would be nice if we can use symlink, or another system to avoid having to change two files in two different places when we need to edit a blog post

Good point but honestly, I think we will only have the issue of duplicates for these first 4 blog posts. Newer ones will have to be added to the changelog directory directly. Btw, it looks like symlink is not supported on Hugo: https://discourse.gohugo.io/t/symbolic-links-not-supported/590

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge PR contains issues or is dependent on another task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a Changelog section to the front page
4 participants