-
-
Notifications
You must be signed in to change notification settings - Fork 18
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
docs: update README.md to align with the style in the README #67
Conversation
It says: > 12. Update the `README.md` header in Title Case format, for example, use `# DDEV Redis`, not `# ddev-redis`. the README itself should follow that advice as well :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, just would probably leave behind the v1.23.4 old ddev get
since we're touching it.
Co-authored-by: Randy Fay <[email protected]>
I don't think this is a good idea. Not sure where it came from. I'm afraid "DDEV Redis" is not a thing, but |
It's from the template guide: https://github.com/ddev/ddev-addon-template?tab=readme-ov-file#getting-started. |
Right. I think you added it, and I wasn't paying adequate attention :) |
Heh, that could be! Though in the comment below from you, it sounds like you did evaluate the proposal. But as a Danish prime minister once said, "You have a standpoint, until you take a new one" :)
From ddev/ddev#5641. |
It's fine in the context of the template, where the DDEV Add-on Template is a "thing", but IMO it doesn't make sense in add-ons. |
I do see a slight advantage in using the machine name in the title, and streamlining the style guide to use that, so that people can then memorize it, for later use on the CLI. So in other words, it should be the reverse, like this?
I can create an MR if you confirm. |
I do prefer that, thanks. You can do it in this PR if you want. |
Great, the MR is now updated. I reversed the order to Header first and then Description, since that's usually the workflow. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works for me, thanks.
The Issue
It says in the README:
the README itself should follow that advice as well :)
How This PR Solves The Issue
Updates the title of the header to use Title Case.
Manual Testing Instructions
Automated Testing Overview
Related Issue Link(s)
Release/Deployment Notes