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

Contributing to Products.CMFPlone is broken #3973

Open
stevepiercy opened this issue Jun 10, 2024 · 2 comments · May be fixed by plone/documentation#1671
Open

Contributing to Products.CMFPlone is broken #3973

stevepiercy opened this issue Jun 10, 2024 · 2 comments · May be fixed by plone/documentation#1671

Comments

@stevepiercy
Copy link
Contributor

stevepiercy commented Jun 10, 2024

As a new to Plone core contributor, you would start by going to our documentation:

https://6.docs.plone.org/contributing/index.html#specific-contribution-policies-of-projects

Which takes you to the repository:

https://github.com/plone/Products.CMFPlone/

And if you happen to know the pattern of checking a repo's CONTRIBUTING.md, you would go there:

https://github.com/plone/Products.CMFPlone/blob/master/CONTRIBUTING.md

Which takes you to outdated documentation.

https://5.docs.plone.org/develop/coredev/docs/guidelines.html

Which rambles on and on about irrelevant topics, until you finally find testing.

https://5.docs.plone.org/develop/coredev/docs/intro.html#testing-locally

And if you have not used buildout, it won't work.

The fallback is to just push a commit, submit a pull request, and tell Jenkins to run tests against your PR. This is slow and wasteful, but there is no other way for new contributors to contribute.

We have clear instructions for documentation, Volto, plone.restapi, and plone.api. I've also ported docs from reStructuredText in version 5.2 to MyST for 6.0, but I've begged and pleaded for anyone, anyone, to help to no avail. I have no clue myself, else I would update the docs.

References: plone/documentation#1278

@rohnsha0
Copy link
Contributor

@stevepiercy so in short we need to update the documentation? in this repo?!

@stevepiercy
Copy link
Contributor Author

@rohnsha0 yes.

In plone/documentation. As I said:

I've also ported docs from reStructuredText in version 5.2 to MyST for 6.0

That is a mere conversion from one syntax to another with only a few grammar, spelling, or syntax fixes. The content itself is still outdated and incorrect for Plone 6.

@stevepiercy stevepiercy linked a pull request Jun 28, 2024 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants