Skip to content

Update the changelog#28

Merged
Mariatta merged 11 commits intomainfrom
update-changelog
Apr 11, 2025
Merged

Update the changelog#28
Mariatta merged 11 commits intomainfrom
update-changelog

Conversation

@Mariatta
Copy link
Member

Summarize the decisions.

Note:
I forgot that we have a "changelog" section.
To prevent future confusion and duplication, I removed the "Changelog.md" file and moved the remaining entry into /content/changelog

I tried my best to add brief summary of each decisions.

Summarize the decisions.
@netlify
Copy link

netlify bot commented Mar 11, 2025

Deploy Preview for pythoneditorialboard ready!

Name Link
🔨 Latest commit eecbabe
🔍 Latest deploy log https://app.netlify.com/sites/pythoneditorialboard/deploys/67f6c2c3bd41450008cbdbd9
😎 Deploy Preview https://deploy-preview-28--pythoneditorialboard.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.

@Mariatta Mariatta marked this pull request as draft March 11, 2025 22:10
@Mariatta
Copy link
Member Author

WIP: I'll go back in our notes and see what else we should add to the changelog.

@Mariatta Mariatta marked this pull request as ready for review March 28, 2025 20:06
Copy link
Member

@nedbat nedbat left a comment

Choose a reason for hiding this comment

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

I've added brief summaries. I think the changelog might be more usable if you didn't have to click into the entries to see the whole thing, since the whole thing is still pretty short. But this is great to get them published somewhere.

Mariatta and others added 4 commits April 9, 2025 09:21
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
@AA-Turner
Copy link
Member

I think the changelog might be more usable if you didn't have to click into the entries to see the whole thing, since the whole thing is still pretty short.

I agree. Would it be possible to keep the single changelog file (deleted in this PR), but expose it on the website? Or perhaps the changelog fragment files could be merged into one rendered page?

A

@Mariatta
Copy link
Member Author

Mariatta commented Apr 9, 2025

I tried rendering the entire changelog entry instead of just the snippet. Please check
https://deploy-preview-28--pythoneditorialboard.netlify.app/changelog/

@@ -1,6 +1,6 @@
---
author: ["Ned Batchelder"]
Copy link
Member

Choose a reason for hiding this comment

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

Does it make sense to have individuals listed as authors for changelog snippets, if the board acts with collective responsibility? Perhaps remove the author, or use "the board"?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm seeing author as "who wrote up this whole post" as opposed to "who made the decision written in this post", but not sure if the rest of the board feels differently.

Copy link
Member

Choose a reason for hiding this comment

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

Threaded conversation

The combined page looks nice, thank you!

Could we remove the reading time and social icons? They're repeated for each item and distracting.

image

Copy link
Member

Choose a reason for hiding this comment

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

I have just spotted that the changelog is paged: https://deploy-preview-28--pythoneditorialboard.netlify.app/changelog/page/2/. Is it possible to put everything on one page (or increase the limit before splitting to a new page to some very high number?)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah I can remove the share and read time

…ons.md

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@Mariatta
Copy link
Member Author

Mariatta commented Apr 9, 2025

I personally want the pagination, but I can keep it a high number, eg 10 or 20.

Set pagination to 10 per page
Remove share links in changelog
Remove redundant breadcrumb
@Mariatta
Copy link
Member Author

Mariatta commented Apr 9, 2025

Changed the page size to 10.
Removed reading time and share icons.
Removed extra breadcrumb.

@Mariatta
Copy link
Member Author

Mariatta commented Apr 9, 2025

Looking at it again, I think I prefer 5 items per page, but I'm ok with 10 for now. I still prefer having to click through to the next page instead of everything presented all in one page.
Anything longer will start feeling like I'm doomscrolling.

@Mariatta Mariatta merged commit 4511c47 into main Apr 11, 2025
4 checks passed
@Mariatta Mariatta deleted the update-changelog branch April 11, 2025 20:51
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.

3 participants