Skip to content

README: Update package list#872

Merged
jackw merged 5 commits into
mainfrom
leventebalogh/update-readme
Jun 17, 2024
Merged

README: Update package list#872
jackw merged 5 commits into
mainfrom
leventebalogh/update-readme

Conversation

@leventebalogh
Copy link
Copy Markdown
Collaborator

@leventebalogh leventebalogh commented Apr 11, 2024

What changed?

Updated the structure of the main README (view the new version →), to make it a bit easier to scan. (This can be totally opinionated, so it's more like a conversation starter.)

Before After
Screenshot 2024-04-11 at 11 15 23 Screenshot 2024-04-17 at 09 12 34

@leventebalogh leventebalogh force-pushed the leventebalogh/update-readme branch from fce5aa6 to b9469e0 Compare April 11, 2024 09:12
@leventebalogh leventebalogh self-assigned this Apr 11, 2024
@leventebalogh leventebalogh added type/docs Changes only affect the documentation chore Other changes that don't modify src or test files no-changelog Don't include in changelog and version calculations skip-release labels Apr 11, 2024
@leventebalogh leventebalogh marked this pull request as ready for review April 11, 2024 09:16
@leventebalogh leventebalogh requested a review from a team as a code owner April 11, 2024 09:16
@leventebalogh leventebalogh requested review from oshirohugo and removed request for a team April 11, 2024 09:16
@grafana grafana deleted a comment from github-actions Bot Apr 11, 2024
@jackw
Copy link
Copy Markdown
Collaborator

jackw commented Apr 11, 2024

I personally prefer the table as I think it looks tidier and the buttons aren't between the name and description which is jarring to read.

I think referring to the packages by their npm name is a nice addition as is updating the descriptions.

@leventebalogh
Copy link
Copy Markdown
Collaborator Author

Those are good inputs - just to make sure I understand correctly what you are suggesting is to go back to the table view, but use the names of the packages (e.g. @grafana/plugin-e2e) and also go with the updated descriptions, right? (How do you feel about getting rid of the readme column, and turning the package names into a link?)

@leventebalogh leventebalogh force-pushed the leventebalogh/update-readme branch from b9469e0 to 6f76d7b Compare April 17, 2024 07:08
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 17, 2024

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

@leventebalogh
Copy link
Copy Markdown
Collaborator Author

leventebalogh commented Apr 17, 2024

What do you think about it now @jackw?

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
leventebalogh and others added 2 commits April 17, 2024 10:13
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Copy link
Copy Markdown
Collaborator

@mckn mckn left a comment

Choose a reason for hiding this comment

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

I like the changes in the table but I vote for keeping the emojis in the list 👍🏻

@leventebalogh
Copy link
Copy Markdown
Collaborator Author

Okie dokie, I'll revive them :)

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Jun 5, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown
Collaborator

@jackw jackw left a comment

Choose a reason for hiding this comment

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

LGTM (once the emojis are back)! 🚀

@jackw jackw merged commit 699136a into main Jun 17, 2024
@jackw jackw deleted the leventebalogh/update-readme branch June 17, 2024 07:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Other changes that don't modify src or test files no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants