Skip to content

January release notes #150

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

Merged
merged 11 commits into from
Jan 19, 2024
Merged

January release notes #150

merged 11 commits into from
Jan 19, 2024

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jan 17, 2024

Internal Notes for Reviewers

This PR includes:

  • Release notes for the sprint that ended January 12, edited for clarity and consistency. Since quite a few PRs used the internal label, the release notes have been combined into a single topic for simplicity.
  • An updated release notes generation script that can generate release notes for only some repos. This change is required for situations like the current release, where only the frontend repo is updated. The previous version of the script would force you to regenerate old release notes or fail if you skipped a repo's release tag.

Output

Capto_Capture 2024-01-18_04-22-15_am

External Release Notes

@nrichers nrichers added the internal Not to be externalized in the release notes label Jan 17, 2024
Copy link
Contributor

@mehdi0501 mehdi0501 left a comment

Choose a reason for hiding this comment

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

Looks like some features were missed due to issues on labeling. We would need to add these to the notes as they significant changes

[VALIDMIND-39] Invite a new member by email by @wkm97 in #516

[VALIDMIND-40] Pending invites displayed in a list by @wkm97 in #521

Fixes text highlighting when there's a comment by @gtagle in #519

Template Detail Page by @panchicore in #491

nrichers and others added 4 commits January 17, 2024 12:54
Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com>
Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com>
Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com>
Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com>
@cachafla
Copy link
Contributor

@mehdi0501 @nikrichers we can also add this if we want to, but note that we haven't documented any of the user management features as release notes yet since the effort was not feature complete.

In any case, more PRs that were marked as internal:

@nrichers
Copy link
Collaborator Author

@mehdi0501 and @cachafla I have added the missing PRs to the release notes, including new sections for:

  • "User and group management"
  • "Template management"

I apologize for how long it's taken me to add these PRs. The text was fairly straightforward once I figured out how to group the missing PRs, but I had to recreate some screen captures and turn .mov files in the original PRs into animated GIFs for the release notes.

The .mov files from the original PRs are not perfect, e.g. one shows a bookmark bar. I did make some edits to smooth out the flow and shorten them a bit. They're ... OK. If you would prefer something better, I would need access to the user management feature as it still doesn't show up for me under my new account on either dev or prod.

The root comment of the PR has been updated with the static output and the release date gas been bumped to Thursday, January 18. If you want to see what the release notes will look like in real life, a preview is on the docs demo site.

Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

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

Amazing 👏 pretty big chunk of updates.

@nrichers
Copy link
Collaborator Author

nrichers commented Jan 19, 2024

The quality of the animated GIFs we had been reusing was really bothering me: they had stray window edges on some sides or included other artifacts that just looked off, and the lack of a border meant they did not really stand out from the background very well. Plus, one of the animated GIFs included a bookmark bar. Not good enough!

I can't recreate the animated GIFs easily, but I ended up cropping them just a little bit to clean up the edges. Adding a border to the GIFs themselves turned out to be a real hassle with the tools I have, but some basic CSS gets us very close to what we need.

In this screenshot, the two top images are standard screenshots created on macOS which is the look we're after. The big image at the bottom is the first of the three animated GIFs in the release notes, now with a border and a similar drop shadow, and no more artifacts. Still not perfect but this now looks clean enough to pass muster.

image

And with this, I'm going to call the release notes done and publish the docs site.

@nrichers nrichers merged commit 5beccdb into main Jan 19, 2024
@nrichers nrichers deleted the january-release-notes branch January 19, 2024 02:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants