Revamped the README file #21744
Revamped the README file #21744
Conversation
|
A reference to the symfony-demo project seems relevant :) If the demo is hosted live somewhere, linking to this live hosted version would be awesome! |
|
What about adding some badges about code coverage or build status? |
|
@Wirone Fabien has always been against badges in the readme. @javiereguiluz there is nothing talking about community reviews anymore. Is it intended ? |
|
@stof ok, I didn't know. Just asking ;-) |
|
Due to composer/packagist#764, the rendering of the readme on Packagist will become weird with this new content, as it will remove the |
README.md
Outdated
| README | ||
| ====== | ||
| <p align="center"><a href="https://symfony.com" target="_blank"> | ||
| <img src="http://symfony.com/logos/symfony_black_02.svg"> |
There was a problem hiding this comment.
What about adding logo to resources, for example in FrameworkBundle and don't rely on external content? There is Symfony svg in WebProfilerBundle but not black and smaller.
There was a problem hiding this comment.
the SVG icons in WebProfilerBundle are part of the features being delivered (as they are displayed in the UI).
However, adding an image in the repo just for the readme looks weird to me.
There was a problem hiding this comment.
We could do that ... but we prefer to link to the symfony.com logo because it gives us more control and flexibility (we could change it for some special occasion, etc.)
There was a problem hiding this comment.
@stof maybe weird, but stable ;-)
@javiereguiluz Ok, I understand, but maybe it should be dedicated resource (symfony_repo_header.svg instead of symfony_black_02.svg)? As far as everyone knows the symfony_black_02.svg is displayed here it's ok, but file could be renamed or deleted.
| It allows you to start a new project based on the version you want. | ||
| * [Install Symfony][4] with Composer or with our own installer (see | ||
| [requirements details][3]). | ||
| * Symfony follows the [semantic versioning][5] strictly, publishes "Long Term |
There was a problem hiding this comment.
Personally I don't think it's about installation, rather about way of developing. I think it should be in different section.
There was a problem hiding this comment.
Yes. This one is tricky. It's not about installation ... but it's about how are Symfony versions released ... which is what you really install/update/use. Creating a new section looked like too much for this.
There was a problem hiding this comment.
So maybe rename section to Installation & maintanance?
README.md
Outdated
| [8]: https://symfony.com/doc/current/contributing/community/reviews.html | ||
| Symfony is an Open Source, community-driven project. Join us [contributing code][17] | ||
| or [contributing documentation][18] and you'll end up in the [Symfony contributors][19] | ||
| Hall of Fame. |
There was a problem hiding this comment.
I don't find this funny, but it's subjective ;-)
There was a problem hiding this comment.
The intention was not to be funny 😐 "Hall of Fame" is a commonly used name to refer to the place where you recognize the merits of some special people. See https://en.wikipedia.org/wiki/List_of_halls_and_walks_of_fame
There was a problem hiding this comment.
I know what is "Hall of Fame" (hey, NBA), but I find this phrase trying to look cool and unofficial. But as I said, it's really subjective.
There was a problem hiding this comment.
I think you are right. In ec8cc27 I've reworded this section. Thanks.
README.md
Outdated
| README | ||
| ====== | ||
| <p align="center"><a href="https://symfony.com" target="_blank"> | ||
| <img src="http://symfony.com/logos/symfony_black_02.svg"> |
There was a problem hiding this comment.
you should use a HTTPS URL here, even though it is not an issue on github as they proxy all images since a long time to avoid mixed content (and other risks)
There was a problem hiding this comment.
Nice catch! Other than that, the only link that doesn't use HTTPS is semver.org ... because they seem to have some issues.
There was a problem hiding this comment.
external links are less an issue regarding mixed content 😄
There was a problem hiding this comment.
regarding HTTPS on semver.org, this is because they are hosted on github pages, and github pages don't support HTTPS for custom domains (the certificate is valid only for the github.io domains)
|
Answering the pending comments: @fbourigault I've added a mention to the Symfony Demo (in the docs section ... I can't find a better place) So, we're good to go :) |
|
Thank you @javiereguiluz. |
This PR was squashed before being merged into the 2.7 branch (closes #21744). Discussion ---------- Revamped the README file | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #21235 | License | MIT | Doc PR | Here is a before/after comparison image:  Commits ------- c7d30ca Revamped the README file
Here is a before/after comparison image: