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

Release v3.6 release discussion #13625

Open
terrytangyuan opened this issue Sep 19, 2024 · 8 comments
Open

Release v3.6 release discussion #13625

terrytangyuan opened this issue Sep 19, 2024 · 8 comments
Labels
type/feature Feature request
Milestone

Comments

@terrytangyuan
Copy link
Member

terrytangyuan commented Sep 19, 2024

We can discuss any important items and issues for v3.6 release.

The 3.6 milestone board is https://github.com/argoproj/argo-workflows/milestone/30

@terrytangyuan terrytangyuan added the type/feature Feature request label Sep 19, 2024
@terrytangyuan
Copy link
Member Author

@Joibel Could you share the draft to the release blog here so that the community can also review it and provide comments?

@terrytangyuan terrytangyuan pinned this issue Sep 19, 2024
@Joibel
Copy link
Member

Joibel commented Sep 19, 2024

The release blog post is here: https://medium.com/@alan_76951/argo-workflows-3-6-aa037cd782be

It should end up in the argoproj medium project, so may then end up community editable. I'm also happy to apply feedback from here or Slack.

@agilgur5
Copy link
Contributor

3.6.0-rc1 CHANGELOG for reference: #13617

@Joibel
Copy link
Member

Joibel commented Sep 20, 2024

I'm generally not happy with how the blog post review thing works for everyone else (it's easier for me as the writer). It's not a good collaboration experience though. We should consider doing it as a google doc (or similar alternative) or PR next time.

I'd like to get a PR in with mostly the same content anyway as a new-features-in-3.6.md type file for the documentation as discussed to make that more discoverable.

The main problem with all of this is the possible options for content and formatting differ quite widely between the different publishing platforms. I was trying to get video snippets in for the UI elements as some of them are hard to understand from a description. I basically gave up after one.

  • Medium does allow animated gifs up to 15Mb. Formatting for images is very restrictive, as are general formatting options.
  • google doc is very flexible, but we'd have to restrict comments there to content really, as it's never the publishing platform.
  • Github markdown has options for up to 10Mb files, but not as part of the committed file set, instead needing manual uploading. This is less satisfactory for review purposes.

So after fighting it for a bit I think I'd like to aim for:

  • feat PRs having a description and media added as part of the review and some tooling to make the first pass of the blog from this. The PR author has the best context for promoting their feature.
  • Settling on a video platform to pop things best presented as moving pictures to use that embeds in github markdown and medium well. (Anyone who has ideas, please add).
  • Using something other than medium for the pre-publication blog post collab.

Having written all this, I should probably turn it into an issue if others agree.

@agilgur5
Copy link
Contributor

  • Settling on a video platform

Argoproj has a YouTube channel. We can add them there either as public vids or unlisted and link from the blog post

  • Medium does allow animated gifs up to 15Mb

If you compress them, this might be enough as well. It'll be low res, but I'm not sure how many people would be clicking through the YT links if we added them anyway.

Also we do already link to the original PRs, which have more context as-is. I think that's fine too tbh. Only a small percentage of folks will click through.

  • google doc is very flexible, but we'd have to restrict comments there to content really, as it's never the publishing platform.

Sounds good enough to me.

Having written all this, I should probably turn it into an issue if others agree.

Maybe a PR to the Releasing docs adding a new section for "Feature Releases" or "Minor Releases"?

@agilgur5 agilgur5 added this to the v3.6.0 milestone Sep 20, 2024
@agilgur5
Copy link
Contributor

It should end up in the argoproj medium project, so may then end up community editable.

Hasn't ended up there yet so I still haven't been able to make edits; there's some formatting issues to correct and some feature edits I'd like to make.

I'm also happy to apply feedback from here or Slack.

Can we add a shout-out to all new Reviewer+ since the last feature post? i.e. to give credit to folks reviewing. Possibly all new Members too? I think it'd be good encouragement in general 🙂

@terrytangyuan
Copy link
Member Author

You can import a story that's written in markdown. Although you'll need to perform some minor edits.

https://danielle-honig.com/blogging/2024/02/08/markdown-to-medium.html

@agilgur5

This comment was marked as resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/feature Feature request
Projects
None yet
Development

No branches or pull requests

3 participants