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.

Sign up for GitHub

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

Jump to bottom

README: Update package list #872

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

README: Update package list #872

wants to merge 4 commits into from

Conversation

leventebalogh
Copy link
Collaborator

@leventebalogh leventebalogh commented Apr 11, 2024 •
edited

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 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
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
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?)

@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 17, 2024 •
edited

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
Collaborator Author

leventebalogh commented Apr 17, 2024 •
edited

What do you think about it now @jackw?

jackw
jackw reviewed Apr 17, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md
✨ Gain inspiration from our [plugin examples](https://github.com/grafana/grafana-plugin-examples/) to get started quickly and implement new features in your plugin.<br/>
🛠️ Use the [Grafana plugin SDK for Go](https://github.com/grafana/grafana-plugin-sdk-go) to simplify the development of backend components.<br/>
✅ Ensure your plugin is ready for publishing to the [Grafana plugin catalog](https://grafana.com/grafana/plugins/) with our [validator](https://github.com/grafana/plugin-validator/) tool.
- [Grafana developer portal](https://grafana.com/developers) - learn from tutorials and read the documentation
Copy link
Collaborator

Choose a reason for hiding this comment

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

What happened to all the emojis? 😢

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Haha, I 🔪d them! 🙈

leventebalogh and others added 2 commits April 17, 2024 10:13
@leventebalogh @jackw
Update README.md
f4b4d7b 
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
@leventebalogh @jackw
Update README.md
abb1b95 
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
mckn
mckn reviewed Apr 23, 2024
View reviewed changes
Copy link
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
Collaborator Author

Okie dokie, I'll revive them :)

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

jackw
jackw approved these changes Jun 11, 2024
View reviewed changes
Copy link
Collaborator

@jackw jackw left a comment •
edited

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)! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mckn mckn mckn left review comments

@jackw jackw jackw approved these changes

@oshirohugo oshirohugo Awaiting requested review from oshirohugo oshirohugo is a code owner automatically assigned from grafana/plugins-platform-frontend

@tolzhabayev tolzhabayev Awaiting requested review from tolzhabayev

@sunker sunker Awaiting requested review from sunker

Assignees

@leventebalogh leventebalogh

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
Plugins Platform
Status: 🔬 In review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@leventebalogh @jackw @CLAassistant @mckn