plone / volto

React-based frontend for the Plone Content Management System
https://demo.plone.org/
MIT License
426 stars 576 forks source link

add outline for user-manual for Volto the Plone 6 frontend #4035

Closed MAX-786 closed 1 year ago

MAX-786 commented 1 year ago

3827

This is the proposed structure or outline of first page for user-manual docs for volto frontend. It is only a start to have something to look at and discuss. Feedback welcome.

Proposed:

https://user-images.githubusercontent.com/99530996/205509532-ec2cbf1c-db66-49e0-b3f5-27fc5ddced82.mp4

This PR has been re-opened at #4069. Sorry for the inconvenience.

netlify[bot] commented 1 year ago

Deploy Preview for volto canceled.

Name Link
Latest commit 0acaccbfbe25db89292cac560311f99d119d4e46
Latest deploy log https://app.netlify.com/sites/volto/deploys/6390b14ff88813000825000f
mister-roboto commented 1 year ago

max_786 your emails are not known to GitHub and thus it is impossible to know if you have signed the Plone Contributor Agreement, which is required to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html How to add more emails to your GitHub account: https://help.github.com/articles/adding-an-email-address-to-your-github-account/

mister-roboto commented 1 year ago

max_786 your emails are not known to GitHub and thus it is impossible to know if you have signed the Plone Contributor Agreement, which is required to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html How to add more emails to your GitHub account: https://help.github.com/articles/adding-an-email-address-to-your-github-account/

stevepiercy commented 1 year ago

@MAX-786 @polyester would you both try to straighten out the email configuration on GitHub? @mister-roboto warnings are annoying.

stevepiercy commented 1 year ago

Also @MAX-786 please let me know when this is ready to review. Thank you!

mister-roboto commented 1 year ago

max_786 your emails are not known to GitHub and thus it is impossible to know if you have signed the Plone Contributor Agreement, which is required to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html How to add more emails to your GitHub account: https://help.github.com/articles/adding-an-email-address-to-your-github-account/

MAX-786 commented 1 year ago

@MAX-786 @polyester would you both try to straighten out the email configuration on GitHub? @mister-roboto warnings are annoying.

Still, @mister-roboto is showing warnings 🥲. Is there any other way or I am thinking of creating a new branch and making a separate pull request with it? this must be annoying for you guys too, sorry for that.

stevepiercy commented 1 year ago

I am thinking of creating a new branch and making a separate pull request with it

Please do not do that. That makes more work for reviewers and it does not solve the issue with @mister-roboto.

In the future, please do not close PRs where there is a long comment and review history. Now I have to look in two different places to reconcile changes for this PR. I would have much preferred that you reopened the PR you closed and continued work on it. There are a few times when it is better to close a PR and open new, such as a bad merge or rebase where the commit history is a nightmare, but that rarely occurs.

As far as @mister-roboto nagifications, please check that the email you use on GitHub matches the one that you submitted in your signed Contributor Agreement that you sent to agreements@plone.org. If there is a mismatch, then please send an email with the correction to agreements@plone.org, and someone will make the correction internally.

@polyester would you please verify that there is no mismatch between what @MAX-786 submitted and the @mister-roboto configuration?

Thank you, both!

polyester commented 1 year ago

The Contributor Agreement is based on github username, and has no concept of email. The PR probably needs a close/reopen, trying that now.

mister-roboto commented 1 year ago

max_786 your emails are not known to GitHub and thus it is impossible to know if you have signed the Plone Contributor Agreement, which is required to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html How to add more emails to your GitHub account: https://help.github.com/articles/adding-an-email-address-to-your-github-account/

polyester commented 1 year ago

So, that didn't help. I will try to find later where the mr.roboto is configured, I have no idea to be honest.

MAX-786 commented 1 year ago

I am thinking of creating a new branch and making a separate pull request with it

Please do not do that. That makes more work for reviewers and it does not solve the issue with @mister-roboto.

In the future, please do not close PRs where there is a long comment and review history. Now I have to look in two different places to reconcile changes for this PR. I would have much preferred that you reopened the PR you closed and continued work on it. There are a few times when it is better to close a PR and open new, such as a bad merge or rebase where the commit history is a nightmare, but that rarely occurs.

As far as @mister-roboto nagifications, please check that the email you use on GitHub matches the one that you submitted in your signed Contributor Agreement that you sent to agreements@plone.org. If there is a mismatch, then please send an email with the correction to agreements@plone.org, and someone will make the correction internally.

@polyester would you please verify that there is no mismatch between what @MAX-786 submitted and the @mister-roboto configuration?

Thank you, both!

Thanks, Steve, 😅I'll keep that in mind next time.

mister-roboto commented 1 year ago

max_786 your emails are not known to GitHub and thus it is impossible to know if you have signed the Plone Contributor Agreement, which is required to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html How to add more emails to your GitHub account: https://help.github.com/articles/adding-an-email-address-to-your-github-account/

stevepiercy commented 1 year ago

@MAX-786 this PR needs a changelog entry, 3827.documentation.

Also is this ready for review? I'd like to keep rolling forward with this, as more people are reporting undocumented features that they want to include in this guide. yay!

mister-roboto commented 1 year ago

max_786 your emails are not known to GitHub and thus it is impossible to know if you have signed the Plone Contributor Agreement, which is required to merge this pull request.

Learn about the Plone Contributor Agreement: http://docs.plone.org/develop/coredev/docs/contributors_agreement_explained.html How to add more emails to your GitHub account: https://help.github.com/articles/adding-an-email-address-to-your-github-account/

MAX-786 commented 1 year ago

Sure I'll add that right now, Also, as mister-roboto is not able to recognize my username, though my other PR is successfully verified so, I figured that the problem is, for agreement verification of this PR mister-roboto is considering author of this PR for verification which was my locally configured user.name = 'max_786' 🥲( which I have corrected now ) . I have googled it but found nothing. Thanks, @stevepiercy for your responses but I don't know how this can be fixed 😣.

davisagli commented 1 year ago

@MAX-786 I think mr.roboto's check is based on emails rather than usernames. The email in the git commit message needs to match the email on your github account.

MAX-786 commented 1 year ago

@MAX-786 I think mr.roboto's check is based on emails rather than usernames. The email in the git commit message needs to match the email on your github account.

Yes and unfortunately I forgot to config my local email on Ubuntu(local machine) some how automatically added this max_786@Ubuntu22.04.myguest.virtualbox.org email with initial commit. I configured later but bot still shows error and the reason might be as I said above.

tiberiuichim commented 1 year ago

@MAX-786 May I propose that you make a new PR? Also, now that you have push permissions, make the PR by pushing directly to the plone/volto repo. This makes it easier for the repo maintainer to incorporate your branch (sometimes PRs are not merged immediately, and they have to be updated with the master before they're merged).

MAX-786 commented 1 year ago

Thanks! then I'll do it now.

stevepiercy commented 1 year ago

@MAX-786 May I propose that you make a new PR?

Yes, that is a good reason to do so, but let's leave this PR open until we can fix this @mister-roboto issue.

stevepiercy commented 1 year ago

Closed by #4069