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

Rename "How you can help" to "Easy ways to contribute"? #154

Closed
sypets opened this issue Apr 17, 2020 · 2 comments
Closed

Rename "How you can help" to "Easy ways to contribute"? #154

sypets opened this issue Apr 17, 2020 · 2 comments

Comments

@sypets
Copy link
Contributor

sypets commented Apr 17, 2020

This is for example used in https://wiki.typo3.org/Document_Matrix

I never was really happy with the title but did not come up with a better title at that time.

@susannemoog
Copy link
Contributor

Tbh I think "How you can help" is fine here because the main menu entry this belongs to is "Contribute to the TYPO3 Documentation" and duplicating the "contribute" is unnecessary. Additionally, I shy away from using words like "easy" as we are judging the users skill level and capabilities by suggesting that if they find something on that list "hard", it's their fault.
I would close this issue for now, if someone comes up with a better naming, we can revisit the topic.

@sypets
Copy link
Contributor Author

sypets commented Dec 1, 2021

Agree. Thanks for taking care of it.

I shy away from using words like "easy" as we are judging the users skill level and capabilities by suggesting that if they find something on that list "hard", it's their fault.

Agree. This is also in Symfony docs style guide:

Avoid belittling words: Things that seem "obvious" or "simple" for the person documenting it, can be the exact opposite for the reader. To make sure everybody feels comfortable when reading the documentation, try to avoid words like:
basically
clearly
easy/easily

https://symfony.com/doc/current/contributing/documentation/standards.html#english-language-standards

and was already corrected and pointed out somewhere else by someone else (don't remember exactly where + who).

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

No branches or pull requests

2 participants