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

docs: update README.md to align with the style in the README #67

Merged
merged 4 commits into from
Dec 5, 2024

Conversation

gitressa
Copy link
Contributor

@gitressa gitressa commented Dec 3, 2024

The Issue

It says in the README:

  1. 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 :)

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

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 :)
Copy link
Member

@rfay rfay left a 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.

README.md Outdated Show resolved Hide resolved
@rfay
Copy link
Member

rfay commented Dec 3, 2024

Update the README.md header in Title Case format, for example, use # DDEV Redis, not # ddev-redis.

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 ddev-redis is.

@gitressa
Copy link
Contributor Author

gitressa commented Dec 3, 2024

@rfay
Copy link
Member

rfay commented Dec 3, 2024

Right. I think you added it, and I wasn't paying adequate attention :)

@gitressa
Copy link
Contributor Author

gitressa commented Dec 3, 2024

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" :)

I don't see any reason this shouldn't be done, but the best path is for you to do PRs in the various repos, which I think you've already started, thanks.

From ddev/ddev#5641.

@rfay
Copy link
Member

rfay commented Dec 3, 2024

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.

@gitressa
Copy link
Contributor Author

gitressa commented Dec 4, 2024

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?

  1. Update the README.md header, adding the machine name of the add-on, for example # ddev-redis, not # DDEV Redis.

I can create an MR if you confirm.

@rfay
Copy link
Member

rfay commented Dec 4, 2024

I do prefer that, thanks. You can do it in this PR if you want.

@gitressa
Copy link
Contributor Author

gitressa commented Dec 5, 2024

Great, the MR is now updated. I reversed the order to Header first and then Description, since that's usually the workflow.

@gitressa gitressa requested a review from rfay December 5, 2024 11:01
Copy link
Member

@rfay rfay left a 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.

@rfay rfay merged commit 79aff47 into ddev:main Dec 5, 2024
2 checks passed
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.

2 participants