-
-
Notifications
You must be signed in to change notification settings - Fork 75
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
buildout.coredev docs need to be pulled into Plone 6 Documentation #840
Comments
Instead of hosting the docs in a separate repo from |
Ping @jensens @polyester @vincentfretin @davisagli @thet @mauritsvanrees @sunew @tkimnguyen @ksuess @spereverde @loechel @esteele @gforcada @svx @ericof as recent contributors to these docs and interested parties for Your opinion is important. |
@stevepiercy yeah, I think that's the right approach. Sorry that I haven't made time to work on it yet. I've been busy sorting out some things with our housing and hope to have more time to contribute soon. |
@stevepiercy Agreed, it makes sense to move this to the main documentation repository. There is no need to keep this here. Well, if the Plone 5 docs are still being generated, then removing the directory here might break it. Best solution for that would be to let the Plone 5 docs get the contents from the coredev 5.2 branch. @polyester you may know that better. Steve, maybe you can make a branch of coredev, convert it to Myst, and link the branch in the documentation issue? Then this can be a basis from which someone working on this can copy files as a good start. Is it best to do one page per PR? It may make sense to add a link to the Plone 5 docs in the index page, as long as not everything is taken over and properly edited yet. |
Agreed. I assume Plone 5.2 docs pull in Until that is determined, I will not remove docs files from this repo.
There are tools in the
In this case, yes, along with updating
Yes, in fact, that would be part of the first step: create the structure first, then populate it with links to existing docs and a todo with a link to an open issue to add content, until we have time to review content. Here is an example of what I mean. |
Consolidating the docs sounds great to me! It will certainly make contributing much easier. Thanks for nudging/pushing/cajoling 😁 |
Consolidating is good. The 5.2 docs pull in coredev from the coredev-5.2 branch, so that should be left alone. In the 6 branch we can move to docs |
I started work on this in plone/documentation#1435. The first pass converted .rst to MyST, and added the The second pass will have all the obsolete stuff removed and MyST syntax cleaned up. |
I have completed both the first and second passes, converting .rst to MyST, adding I also added a lot of TODOs and comments to guide authors and contributors with what I think should be done with the content. I think a couple of pages should be purged, but other contributors may disagree, so I left them in place for further discussion. All this work was done in plone/documentation#1435 and merged to the branch https://github.com/plone/documentation/tree/6-dev/coredev The next question is where in
The remaining todos before closing this issue are:
|
Started working on this in the contributing branch of documentation: https://github.com/plone/documentation/tree/contributing |
I have been working on this in a separate PR at plone/documentation#1478. The old v5 contributing is not good for v6. Let's discuss this before you invest a lot of time in it. |
The docs for
buildout.coredev
do not get imported into Plone 6 Documentation at this time. They exist only at https://5.docs.plone.org/develop/coredev/docs/index.html.First the docs need to be converted to MyST.
After conversion, they need to be thoroughly reviewed and updated for accuracy, especially now that we have Volto as the default Plone 6 fronted. No copy-pasta! If something is not complete, we need to include a todo with a link to an issue to update the content.
See plone/documentation#1278
I will be the champion of this issue, but I need help with the content from experienced Plonistas.
The text was updated successfully, but these errors were encountered: