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

0.1.5 release notes #3449

Merged
merged 17 commits into from Feb 28, 2024
Merged

0.1.5 release notes #3449

merged 17 commits into from Feb 28, 2024

Conversation

seancolsen
Copy link
Contributor

@seancolsen seancolsen commented Feb 20, 2024

Rendered release notes

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@seancolsen seancolsen added this to the v0.1.5 milestone Feb 20, 2024
@seancolsen seancolsen changed the base branch from develop to 0.1.5 February 27, 2024 03:05
@seancolsen
Copy link
Contributor Author

@mathemancer would you be willing to fill in the TODO content within the "Upgrading" section?

@seancolsen
Copy link
Contributor Author

Also @mathemancer I'd like you to review the rest of this doc. I know we had talked about doing this together — synchronously — but the content is so small and we've both had such tricky schedules that I figured I'd forge ahead with it and get you to review.

In particular, for #3448, I wrote:

Improve performance of loading sample data when adding a new connection

Does this seem correct?

Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

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

I found a couple of minor typos, just pushed changes myself.

I note that these release notes are not yet included in the nav configuration. I'm assuming this is known and intended, so I didn't change that.

@seancolsen
Copy link
Contributor Author

Thanks @mathemancer I pushed 75a2b09 to add the release notes to the nav.

@seancolsen seancolsen marked this pull request as ready for review February 28, 2024 16:39
@seancolsen
Copy link
Contributor Author

This is ready to merge now.

I'll merge this as part of our release publication process. But I'll wait until QA is complete first.

@kgodey
Copy link
Contributor

kgodey commented Feb 28, 2024

@seancolsen I hadn't actually reviewed the content of the release notes, I'd like to suggest two small changes:

Also, do we need to add the upgrading notes to the "Upgrade" section of nav in the main Mathesar docs? Currently it only lists 0.1.4 and older versions: https://docs.mathesar.org/

@kgodey
Copy link
Contributor

kgodey commented Feb 28, 2024

@seancolsen I made the changes I suggested + a couple more:

  • I renamed "features" to "improvements" since I don't think those are features.
  • I moved constraining the width of the connections page to the "improvements" section.

A couple of things to note:

  • I did not update the template or the script file, I didn't have time to look into how they work and if my changes to the headers / ordering will need any corresponding changes.
  • The 0.1.5 upgrade page is almost identical to the "older versions" upgrade page, might be worth making the content DRY at some point, maybe use a snippet.

@seancolsen
Copy link
Contributor Author

Thanks @kgodey. I pushed 75aacba to update the template too.

@seancolsen seancolsen merged commit cd71772 into 0.1.5 Feb 28, 2024
2 checks passed
@seancolsen seancolsen deleted the release_notes branch February 28, 2024 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants