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

docs: de-pep8 docs, improve some docs parts #386

Merged
merged 1 commit into from
Jan 14, 2018
Merged

Conversation

svx
Copy link
Member

@svx svx commented Jan 14, 2018

This PR improves some parts of the docs by:

  • 'un-pep8' docs, use whole sentences
  • improve code-blocks
  • improve wording
  • add links for background information

@gforcada gforcada merged commit c080b8e into 5.1 Jan 14, 2018
@gforcada gforcada deleted the docs_improvements branch January 14, 2018 14:30
@gforcada
Copy link
Sponsor Member

@svx will you push these changes to 5.2 branch as well?

@@ -8,8 +7,7 @@ which assigns copyright in the code to the Plone Foundation, the non-profit orga

This document explains the purposes of this, along with questions and answers about what this means.

The Plone Contributor Agreement can be found at:
`<https://plone.org/foundation/contributors-agreement/agreement.pdf>`_.
You can download *The Plone Contributor Agreement* from `plone.org <https://plone.org/foundation/contributors-agreement/agreement.pdf>`_.
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

I think this link should point instead to https://plone.org/foundation/contributors-agreement/ rather than directly to the PDF, and the information here on docs.plone.org about the contributor agreement should not be duplicated here; it is best left on plone.org

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

3 participants