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

Create docs on docs.plone.org for this image #46

Open
jensens opened this issue Jan 18, 2022 · 8 comments
Open

Create docs on docs.plone.org for this image #46

jensens opened this issue Jan 18, 2022 · 8 comments
Assignees
Labels
04 type: enhancement making existing stuff better 21 status: confirmed issue was read and got confirmed 33 needs: docs missing documentation: write it

Comments

@jensens
Copy link
Member

jensens commented Jan 18, 2022

The README here lands on Docker Hub, so it should contain basic about the image and Plone.
In depth information has to be moved to docs.plone.org (6-dev branch)
@stevepiercy knows better where to put it there. Lets keep this issue open until this is finished.

@jensens jensens added 04 type: enhancement making existing stuff better 21 status: confirmed issue was read and got confirmed 33 needs: docs missing documentation: write it labels Jan 18, 2022
@stevepiercy
Copy link
Contributor

To clarify, the only docs I see in this repo are in README.md. Is that correct?

Does in-depth information exist somewhere? If so, where?

As far as where in-depth docs of backend should go, anyone can create a pull request against the 6-dev branch. There is a subdirectory docs/backend with a draft structure awaiting content.

@jensens
Copy link
Member Author

jensens commented Jan 31, 2022

I think we need some kind of deployment documentation, so there will be.

@jensens
Copy link
Member Author

jensens commented Oct 16, 2022

we have the deployment training now, this can be closed

@jensens jensens closed this as completed Oct 16, 2022
@stevepiercy
Copy link
Contributor

stevepiercy commented Oct 16, 2022

No, Training is not the authoritative source for Documentation. We maintain Documentation all the time now, whereas a Training is usually only updated by the author. Additionally we do not want to punish users to go between two websites to get the information they seek. Please reopen.

@jensens jensens reopened this Oct 16, 2022
@jensens
Copy link
Member Author

jensens commented Oct 16, 2022

I will change the ticket title

@jensens jensens changed the title Move main docs to 6-dev branch for docs.plone.org Create docs on docs.plone.org for this image Oct 16, 2022
@stevepiercy
Copy link
Contributor

@jensens for some reason, I cannot assign this ticket to myself or add it to the Plone 6 Docs release GitHub Project. I could not reopen the ticket myself yesterday either. Would you please check my permissions on this repository, and grant me sufficient rights? Thank you!

After I have the opportunity to run through the training and provide feedback in a couple of weeks, then I'll work on this ticket.

@jensens
Copy link
Member Author

jensens commented Oct 17, 2022

@stevepiercy indeed, Developers group had only read access. @ericof by intend? Anyway, I change this to "Triage".

@stevepiercy
Copy link
Contributor

@jensens thanks. Assigned and added to the GitHub project Release Plone 6 docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
04 type: enhancement making existing stuff better 21 status: confirmed issue was read and got confirmed 33 needs: docs missing documentation: write it
Projects
Status: Todo
Development

No branches or pull requests

2 participants