Skip to content

Conversation

@Sneha-Goswami123
Copy link

@Sneha-Goswami123 Sneha-Goswami123 commented Jan 7, 2026

Fixes plone/training#991

Add a clear reference from the training documentation to the
authoritative Plone 6 installation documentation to avoid
duplicating installation instructions.


📚 Documentation preview 📚: https://plone6--2028.org.readthedocs.build/

@boring-cyborg
Copy link

boring-cyborg bot commented Jan 7, 2026

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, read Plone's Code of Conduct and Contribute to documentation, as this will greatly help the review process.

Welcome to the Plone community! 🎉

Comment on lines 1 to 9
---
myst:
html_meta:
"description": "Plone Training"
"property=og:description": "Plone Training"
"property=og:title": "Plone Training"
"keywords": "Plone, Training"
---

Copy link
Member

@boss6825 boss6825 Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This need not to be removed for this issue

For supported and up-to-date installation methods, please refer to the
authoritative Plone 6 documentation:

https://6.docs.plone.org/install/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not put raw URLs as it can't be integrated with Sphinx
this would work here- {doc}/install/index

@boss6825
Copy link
Member

boss6825 commented Jan 7, 2026

@stevepiercy does this Issue expected to audit Training content and remove any duplicated/outdated install steps,
replace with a single reference to the authoritative docs.
I think it might require to change:

  • individual training modules/lessons with installation sections
  • any training content where install instructions are embedded

@Sneha-Goswami123
Copy link
Author

Thanks for the clarification!
I’ve updated the link to use Sphinx {doc} syntax and kept the front-matter unchanged.

@Sneha-Goswami123
Copy link
Author

Thanks for the clarification!
I’ve updated the link to use Sphinx {doc} syntax and kept the front-matter unchanged.

@stevepiercy
Copy link
Contributor

@Sneha-Goswami123 sorry, the original issue should have been in the Training repo, not this one. Moved issue to plone/training#991 where it should be fixed. Closing.

@stevepiercy stevepiercy closed this Jan 7, 2026
@github-project-automation github-project-automation bot moved this from New to Done in Plone Documentation Jan 7, 2026
@stevepiercy
Copy link
Contributor

@Sneha-Goswami123 before jumping into any open source project, ALWAYS read their contributing guidelines. It will save you time, effort, and frustration.

Please read and follow First-time contributors, especially Things not to do, Contributing to Plone, and Contributing to Volto.

@Sneha-Goswami123
Copy link
Author

Thank you for the feedback — understood.

I’ve read through the First-time Contributors guidelines and the relevant
contributing documentation. I appreciate the clarification about repository
scope and will make sure to verify this carefully before working on future
issues.

Thanks for your guidance.

@Sneha-Goswami123
Copy link
Author

@Sneha-Goswami123 sorry, the original issue should have been in the Training repo, not this one. Moved issue to plone/training#991 where it should be fixed. Closing.

Thanks for the clarification — understood.

I see that this change belongs in the plone/training repository.
I’ll apply the same fix there under the moved issue and follow the
contributing guidelines carefully.

Thanks for the guidance.

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

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Update relevant Training docs to point to authoritative Plone 6 Docs for installation

3 participants