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

Transfer Plone Deprecation Guide? #1464

Open
1 of 2 tasks
jensens opened this issue Mar 12, 2023 · 4 comments
Open
1 of 2 tasks

Transfer Plone Deprecation Guide? #1464

jensens opened this issue Mar 12, 2023 · 4 comments

Comments

@jensens
Copy link
Member

jensens commented Mar 12, 2023

Plone Documentation versions affected

  • 5.x
  • 6.x

Description

I would like to update and transfer the Plone Deprecation Guide to the new docs. But where would it fit?

It needs to be converted to MyST from its source https://github.com/plone/documentation/blob/5.2/develop/styleguide/deprecation.rst using rst-to-myst as described in https://6.docs.plone.org/contributing/documentation/admins.html#importing-external-docs-and-converting-to-myst.

@stevepiercy
Copy link
Contributor

Good question.

We have not yet migrated the Develop docs from the 5.2 branch on plone/documentation.

buildout.coredev docs covers some of the same guidelines and policies.

I think before we take any action, we should take inventory of all the current docs that are policies or guidelines for contributing and developing, then figure out where all the bits will fall into place. I am on board to help determine the structure of these docs. Would you like to take the lead to come up with a plan?

References:

@jensens
Copy link
Member Author

jensens commented Mar 12, 2023

Would you like to take the lead to come up with a plan?

Not now: time limitations. Also, I think first we should finish the current docs. But keep this on hold and come back later.

@stevepiercy
Copy link
Contributor

With the merge of #1486, this issue can now be worked on. @jensens back to you!

@stevepiercy
Copy link
Contributor

stevepiercy commented Oct 28, 2024

Following up on this. This guide is a combination of a Conceptual guide and a How-to guide, and it needs to be split into its two parts. For a definition of these two, see https://diataxis.fr/.

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

No branches or pull requests

2 participants