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.

Sign up for GitHub

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

Jump to bottom

Docs: Fix link and typo #383

Merged
merged 3 commits into from
Dec 7, 2017
Merged

Docs: Fix link and typo #383

merged 3 commits into from
Dec 7, 2017

Conversation

svx
Copy link
Member

@svx svx commented Dec 3, 2017

This PR fixes the reST syntax of the link to: https://plone.org/foundation/contributors-agreement/agreement.pdf and a typo.

@svx svx mentioned this pull request Dec 3, 2017
Closed
@svx svx requested a review from gforcada December 3, 2017 14:42
tkimnguyen
tkimnguyen reviewed Dec 3, 2017
View reviewed changes
docs/contributors_agreement_explained.rst
===========================================
Contributor’s Agreement for Plone Explained
Contributor’s Agreement For Plone Explained
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

prepositions in titles are not usually capitalized

Copy link
Member Author

Choose a reason for hiding this comment

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

There are, please check our style guide

Copy link
Sponsor Member

Choose a reason for hiding this comment

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

OK. That goes against what I was taught, but all right.

Copy link
Member Author

Choose a reason for hiding this comment

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

Why ?
We have that in our style-guide and slowly changing lots of headings.

In the world of technical writing there are tons of opinions about how headings should look like.

There are even tons of talks about that topic on every ' docs conference'.

Google is doing it different than Facebook and FB is doing it different than company X.

There is currently no right or wrong.

There a valid reasons for lots of different ways on how to to it.

The important point is if you decide on one way use it through the whole docs. And this is exactly what we are doing/improving now.

tkimnguyen
tkimnguyen reviewed Dec 3, 2017
View reviewed changes
docs/contributors_agreement_explained.rst Outdated
@@ -62,7 +62,7 @@ Do I have to sign the contributor's agreement to submit a patch to the Plone cor

We enthusiastically welcome patches,
but we can't merge them until you sign and return a contributor's agreement.
(Unless, in the judgement of the Plone Release Manager, the patch is so tiny as not to constitute a "creative work".
(Unless, in the judgment of the Plone Release Manager, the patch is so tiny as not to constitute a "creative work".
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

both spellings are correct

Copy link
Member Author

Choose a reason for hiding this comment

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

So what is the issue here then ?

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 guess it was a 'If it ain't broke, why fix?' but up to you

tkimnguyen
tkimnguyen reviewed Dec 3, 2017
View reviewed changes
docs/contributors_agreement_explained.rst Outdated
@@ -73,7 +73,7 @@ so that I can contribute the same code to other projects under different terms o
Does the Foundation control use of the Plone trademark?

Yes.
In order to keep the trademark,
to keep the trademark,
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

Since that is the start of a new sentence, "To" should be capitalized

Copy link
Member Author

Choose a reason for hiding this comment

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

Right ! Would be easier to spot if people start to write for humans and ditch 'weird' coding styles for docs.. just saying ...

Copy link
Member Author

Choose a reason for hiding this comment

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

or in his case here, follow and learn reST ...

Copy link
Sponsor Member

Choose a reason for hiding this comment

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

Yeah these Q & A formats aren't working on this page.

tkimnguyen
tkimnguyen approved these changes Dec 3, 2017
View reviewed changes
Copy link
Sponsor Member

@tkimnguyen tkimnguyen left a comment

Choose a reason for hiding this comment

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

+1

docs/contributors_agreement_explained.rst Outdated
@@ -73,7 +73,7 @@ so that I can contribute the same code to other projects under different terms o
Does the Foundation control use of the Plone trademark?

Yes.
In order to keep the trademark,
to keep the trademark,
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

Yeah these Q & A formats aren't working on this page.

@svx
Copy link
Member Author

svx commented Dec 7, 2017

The @plone/documentation-team would like to release a new docs build.

Would someone mind to merge this PR if there are no objections ?

Thanks !

@gforcada gforcada merged commit c2b099a into 5.1 Dec 7, 2017
@gforcada
Copy link
Sponsor Contributor

gforcada commented Dec 7, 2017

I'm looking forward to the new docs!

@jensens jensens deleted the svx_docs_fix_link branch March 29, 2018 13:30
mister-roboto pushed a commit that referenced this pull request Oct 5, 2023
@mauritsvanrees
[fc] Repository: plone.app.event
98713e6 
Branch: refs/heads/master
Date: 2023-09-01T18:50:34+02:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: plone/plone.app.event@ac473af

Fix test_long_event when run around midnight of the first day of the month.

Fixes plone/plone.app.event#334.

Files changed:
A news/334.tests
M plone/app/event/tests/test_portlet_calendar.py
Repository: plone.app.event

Branch: refs/heads/master
Date: 2023-10-05T11:21:59+02:00
Author: Jens W. Klein (jensens) <jk@kleinundpartner.at>
Commit: plone/plone.app.event@9ff0aa9

Merge branch 'master' into maurits-test-long-event-master

Files changed:
A news/172.internal
M .pre-commit-config.yaml
M pyproject.toml
M tox.ini
Repository: plone.app.event

Branch: refs/heads/master
Date: 2023-10-05T16:10:25+02:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: plone/plone.app.event@71757d6

Merge pull request #383 from plone/maurits-test-long-event-master

Fix test_long_event when run around midnight of first day of month

Files changed:
A news/334.tests
M plone/app/event/tests/test_portlet_calendar.py
mister-roboto pushed a commit that referenced this pull request Oct 5, 2023
@mauritsvanrees
[fc] Repository: plone.app.event
163fec1 
Branch: refs/heads/master
Date: 2023-09-01T18:50:34+02:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: plone/plone.app.event@ac473af

Fix test_long_event when run around midnight of the first day of the month.

Fixes plone/plone.app.event#334.

Files changed:
A news/334.tests
M plone/app/event/tests/test_portlet_calendar.py
Repository: plone.app.event

Branch: refs/heads/master
Date: 2023-10-05T11:21:59+02:00
Author: Jens W. Klein (jensens) <jk@kleinundpartner.at>
Commit: plone/plone.app.event@9ff0aa9

Merge branch 'master' into maurits-test-long-event-master

Files changed:
A news/172.internal
M .pre-commit-config.yaml
M pyproject.toml
M tox.ini
Repository: plone.app.event

Branch: refs/heads/master
Date: 2023-10-05T16:10:25+02:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: plone/plone.app.event@71757d6

Merge pull request #383 from plone/maurits-test-long-event-master

Fix test_long_event when run around midnight of first day of month

Files changed:
A news/334.tests
M plone/app/event/tests/test_portlet_calendar.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tkimnguyen tkimnguyen tkimnguyen approved these changes

@gforcada gforcada Awaiting requested review from gforcada

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@svx @gforcada @tkimnguyen