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

The Dexterity-reference from the training and the dexterity docs should both move into docs #1298

Open
3 tasks
stevepiercy opened this issue Sep 7, 2022 · 2 comments

Comments

@stevepiercy
Copy link
Contributor

stevepiercy commented Sep 7, 2022

The Dexterity-reference from the training (https://training.plone.org/5/mastering-plone/dexterity_reference.html) and the dexterity docs should both move into plone/documentation. I would not pull the dexterity docs in (as a submodule) but rather move it there since it is very very "core".

Sources

Advantages

  • Core docs should be in the plone/documentation, instead of scattered across multiple repositories.
  • More likely to get contributions through the plone/documentation repository. No need to explain, "Oh, sorry, you have to go over to plone/plone.app.dexterity to update this one section of the docs."
  • No need to deal with submodules.

Disadvantages

  • Docs would not be kept together with the project.

To Dos

See also

Originally posted by @pbauer in #1290 (comment)

@jensens
Copy link
Member

jensens commented Sep 8, 2022

+100

Also consider to include the plone.behavior readme https://github.com/plone/plone.behavior/blob/master/README.rst (and reduce it to a link to the docs).

@stevepiercy
Copy link
Contributor Author

Also consider to include the plone.behavior readme https://github.com/plone/plone.behavior/blob/master/README.rst (and reduce it to a link to the docs).

Agreed. Created new issue: #1309

Are there other external docs that should be moved into plone/documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

2 participants