Fixed development environment setup commands

[ktsrivastava29]

I edited the command in the readme file; previously, there was a $ symbol before it, and when using direct copy, the $ symbol used to get copied as well; moreover,

npm install -g yo @plone/generator-volto 

requires sudo access, so sudo was put before it. Please look into it; if any other changes are needed, I'll be happy to make them.

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[netlify[bot]]

✔️ Deploy Preview for volto ready!

🔨 Explore the source changes: 8aca6d3350b63062b2c14d828168b72d6d302ef2

🔍 Inspect the deploy log: https://app.netlify.com/sites/volto/deploys/62304d9f772f3f0008e2024f

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

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[tiberiuichim]

The dollar $ sign is sometimes used to show that some commands are supposed to entered in the shell. I think it's an old habit, probably not needed anymore. The first hit for "bash tutorial" is filled with these sort of examples. I guess the expectation is that the user is familiar with the convention. The other convention, which is to use the # sign for the command prompt is stranger (as it typically denotes a comment), so that's probably why the initial author tried to avoid it.

[stevepiercy]

@ktsrivastava29 have you submitted your signed Plone Contributor Agreement? http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[stevepiercy]

The dollar $ sign is sometimes used to show that some commands are supposed to entered in the shell. I think it's an old habit, probably not needed anymore.

Yup. In Plone Trainings and Documentation, we agreed that the shell prompts are not helpful. They get in the way of copy-paste. It definitely is a habit carried over from plain text documentation that lacks Sphinx, Pygments, and copy-button.

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[ktsrivastava29]

I've changed the docs folder structure that fixes the issue #3093 Any suggestions for further improvement will appreciated

[ktsrivastava29]

I think I should create a new PR for this issue

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[stevepiercy]

Once final docs for Plone 6 are published, we'll need to update the URLs

I added two todos just now to remind us to do that thing. Thank you!

https://github.com/plone/documentation/issues/1140

• [ ] In conf.pys in submodules, update the Intersphinx plone target to docs.plone.org or perhaps with 6 in the host name or URI path.
• [ ] In plone/volto's README.md, update the URLS containg 6.dev-docs.plone.org to docs.plone.org, or perhaps with 6 in the host name or URI path.

[stevepiercy]

@ktsrivastava29 it is OK to keep this PR open and moving forward because we have the history of our discussion and why we decided to do the things we did in one place. A new PR would add one more place to look and makes lazy developers (like me) sad. If you're concerned about a long commit history, we can do a squash merge commit.

Meanwhile we cannot merge any PR from you unless you have signed the Plone Contributor Agreement. The overly-helpful bot @mister-roboto reminds us with each of your commits until we have received and processed it.

As a side note, which link to the Plone Contributor Agreement would be more helpful for new contributors?

• https://plone.org/foundation/contributors-agreement
• http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html (from @mister-roboto)

In either case, we need to update the link that @mister-roboto emits because it uses http.

EDIT: I created a post in Plone Community at: https://community.plone.org/t/how-to-update-mister-roboto-link-to-plone-contributor-agreement/14952

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[ktsrivastava29]

Meanwhile we cannot merge any PR from you unless you have signed the Plone Contributor Agreement. The overly-helpful bot @mister-roboto reminds us with each of your commits until we have received and processed it.

@stevepiercy I've already emailed the signed pdf, but I'm not sure why the bot still says I haven't signed; I've attached a screenshot for you to look at.

Actually, the documents folder issue #3093 was a little different from this one, so I created a second PR for it #3144 . Should I close that PR and make the changes solely here?

Working with the organisation, I'm learned a lot along the way, I'm grateful that my PR and comments are getting noticed. I look forward to continue working with this.

[stevepiercy]

@stevepiercy I've already emailed the signed pdf, but I'm not sure why the bot still says I haven't signed; I've attached a screenshot for you to look at.

OK, thank you! A human must review your agreement, then press a button somewhere. If it happened on a weekend, please wait until later today. If you do not hear back, then we can escalate it to whoever has that power. Maybe @tkimnguyen knows?

Actually, the documents folder issue #3093 was a little different from this one, so I created a second PR for it #3144 . Should I close that PR and make the changes solely here?

No. It is an unrelated issue.

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[mister-roboto]

@ktsrivastava29 you need to sign the Plone Contributor Agreement in order to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html

[ktsrivastava29]

@stevepiercy I received a mail saying my agreement has been accepted but still I can see the bot asking me to sign the agreement. I didn't even receive any such notifications from github

[ktsrivastava29]

@stevepiercy Thank You, my application has been accepted, can you tell how can this PR be merged

[stevepiercy]

I see in the CI/CD that the remaining failure is a lack of an entry in CHANGELOG.md. That should remove the blocker.

[ktsrivastava29]

@stevepiercy now I've added the entry to changelog. I believe this PR is now good to get merged

[tkimnguyen]

Steve is right: the agreement has to be processed manually and then you would be added to the plone GitHub organization

[ktsrivastava29]

@tkimnguyen the agreement has already been processed and now we don't see that bot asking to sign the agreement. So I believe we can go on merging this PR to master

[stevepiercy]

I confirm that the addition of the change log entry removed the blocker of the signed Plone Contributor Agreement. One if the suggestions I made was resolved without action. Please incorporate it, then I can approve. Thank you!

[ktsrivastava29]

@stevepiercy I apologize; I made those modifications but somehow didn't save the file, as a result of which it was neither committed nor pushed; now that I've made the necessary adjustments, you can see them.

[ktsrivastava29]

@stevepiercy Thank you for pointing out this, I've fixed this now, please have a look

[sneridagh]

Really?

[sneridagh]

Sorry, this is mostly my fault for not weighing in, taking into account that I nurture this README since the very beginning. This is the current README Getting Started section:

https://github.com/plone/volto#quick-start

For me, a getting started section helps me to really get started in matter of minutes. No further clicking, just test the thing locally in my own machine. If you go now through it, I can't do that. Also:

For detailed installation instructions and troubleshooting tips, see the documentation.

Points to the install of the version manager? Also the link points to the old docs domain.

Given the importance of today (the day after we released Volto 15), I have to ask you to revert this.

[sneridagh]

@ktsrivastava29 you are welcome to open again the PR. However, I think the README is a very special entry point and has to be carefully thought and reviewed. Communication is paramount either for community members and external, potential Plone adopters.

If you take a look at other project's Quick Start guide tend to be concise and directly to the point. Volto is a bit more complex to setup, so the section should be long for sure.

We should move other parts to the docs? I think we could, training, talks, videos, development directions, etc.

Let's continue the discussion about it.

[ktsrivastava29]

@sneridagh Thank you, soon I'll be opening a PR again and we can have a discussion over there.