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

Update readme 2022 #3131

Merged
merged 6 commits into from Mar 10, 2022
Merged

Update readme 2022 #3131

merged 6 commits into from Mar 10, 2022

Conversation

sneridagh
Copy link
Member

@sneridagh sneridagh commented Mar 9, 2022

I wanted to update it before releasing Volto 15.

* master:
  Contents Rename Modal, use `id` Widget type, Add `id` as widget type … (#3127)
@netlify
Copy link

netlify bot commented Mar 9, 2022

✔️ Deploy Preview for volto ready!

🔨 Explore the source changes: b46ba32

🔍 Inspect the deploy log: https://app.netlify.com/sites/volto/deploys/6228e6009b29b800090cc254

😎 Browse the preview: https://deploy-preview-3131--volto.netlify.app

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Just a few English syntax and grammar things, and a few MyST syntax things.

I might suggest simplifying the README by moving content from it into the docs, and linking to the docs. It's a pretty long readme.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@@ -222,14 +216,14 @@ JavaScript-centered trainings.

## Browser support

Volto works well with any modern (and updated) browser, including their mobile
Volto works well with any modern (evergreen) browser, including their mobile
Copy link
Collaborator

Choose a reason for hiding this comment

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

What does "evergreen" mean? I've never heard that term used for a web browser, but only for trees and shrubbery.

Copy link
Member Author

Choose a reason for hiding this comment

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

It seems it's a trendy word now... I've already seen it in a number of places refers to those browsers that are automatically updated... so all modern browsers.

Copy link
Sponsor Member

Choose a reason for hiding this comment

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

"modern browser" would do IMHO.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Steve Piercy <web@stevepiercy.com>
@sneridagh
Copy link
Member Author

@stevepiercy Thanks for watching over my crappy English Grammar :P

@sneridagh
Copy link
Member Author

Just a few English syntax and grammar things, and a few MyST syntax things.

I might suggest simplifying the README by moving content from it into the docs, and linking to the docs. It's a pretty long readme.

What sections would you move to the docs? I guess all is about quick tips and directions for newbies, so the README contains all the necessary to quick start and make themselves an idea of what to expect, and try Plone 6 quickly.

I'm open to it, but I think we could do it later, after Volto 15 is released.

@sneridagh
Copy link
Member Author

hehe the logo inverted in dark mode:

image

How cool is that? :P

@ksuess
Copy link
Member

ksuess commented Mar 9, 2022

I think a hint to the ecosystem of add-ons via a link to "Awesome Volto" https://github.com/collective/awesome-volto would be beneficial.

@sneridagh
Copy link
Member Author

I think a hint to the ecosystem of add-ons via a link to "Awesome Volto" https://github.com/collective/awesome-volto would be beneficial.

@ksuess I included it already:

https://github.com/plone/volto/pull/3131/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R31

@sneridagh sneridagh requested a review from tisto March 9, 2022 16:30
@stevepiercy
Copy link
Collaborator

What sections would you move to the docs? I guess all is about quick tips and directions for newbies, so the README contains all the necessary to quick start and make themselves an idea of what to expect, and try Plone 6 quickly.

Anything that already exists in the docs should be removed and linked to. Keep it DRY.

Other than that, if the part becomes too "document-ish", then it probably belongs in the docs. That's a subjective call.

It might be best to create a Quick Start Guide.

I'm open to it, but I think we could do it later, after Volto 15 is released.

I totally agree. Shall I make a new issue to track it?

@stevepiercy
Copy link
Collaborator

hehe the logo inverted in dark mode:

image

How cool is that? :P

What did the Volto Marketing Team have to say about inverting the logo colors? 😜

That is nifty.

@sneridagh
Copy link
Member Author

hehe the logo inverted in dark mode:
image
How cool is that? :P

What did the Volto Marketing Team have to say about inverting the logo colors? 😜

That is nifty.

😂

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.

None yet

5 participants