training icon indicating copy to clipboard operation
training copied to clipboard

Updated Trainings Docs

Open Vivek-04022001 opened this issue 2 years ago • 5 comments

Description: I enhanced the language flow in the paragraph, making it easier to comprehend. The previous version was challenging to understand, but the revised version is now more accessible and user-friendly. I, Vivek Kumar, agree to have this contribution published under the Creative Commons 4.0 International License (CC BY 4.0), with attribution to the Plone Foundation.

Vivek-04022001 avatar Jan 21 '24 19:01 Vivek-04022001

Deploy Preview for plone-training ready!

Name Link
Latest commit aa49b8ca7daa0981449e45e0ae76c1c4cf3b7c8d
Latest deploy log https://app.netlify.com/sites/plone-training/deploys/65bdcf2dffcfd6000866100b
Deploy Preview https://deploy-preview-833--plone-training.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Jan 21 '24 19:01 netlify[bot]

I appreciate that you looked into this training chapter so detailed. Thanks for the feedback. But I do not agree with your suggestions. It's necessary to use the vocabulary like default view, component, create, contain, etc.. I'll consider your thoughts in the upcoming overhaul.

ksuess avatar Jan 24 '24 10:01 ksuess

Thank you, @ksuess, for your corrections. As a new contributor to Plone, I'm committed to being an active member of this community and learning from experienced mentors. Presently, I've been closely connected with @stevepiercy, who has been guiding me on how to contribute effectively to an open-source organization like Plone. I've gained valuable insights from his mentorship.

I have a minor question. As a newcomer to this organization, I spend a significant amount of time reading documentation daily. In an effort to assist other new developers in navigating the docs more easily, I occasionally point out errors. However, if the entire documentation is set to be updated soon, I'd like your guidance. Should I primarily focus on coding contributions or continue to allocate some attention to documentation contributions as well? I would appreciate your approval on the best approach.

Vivek-04022001 avatar Jan 25 '24 12:01 Vivek-04022001

@Vivek-04022001 please note that Training is a collection of trainings that are conducted in person at each Plone Conference every year (and sometimes for hire). Official Plone 6 Documentation is at https://6.docs.plone.org/. Many trainings refer to that as the authoritative source.

@ksuess refers to overhauling only the Mastering Plone training. Other trainers update their own trainings, usually about a month or two before the conference.

Corrections for errors and omission are welcome, as is feedback. However it better to file an issue, not a pull request, to discuss what should change, if anything. That saves everyone time and effort. See Work with GitHub issues.

stevepiercy avatar Jan 25 '24 13:01 stevepiercy

@ksuess, I'm reflecting on your suggestion to maintain all the terms mentioned in the docs. As a result, I propose a new change to you.

1.A page usually displays its blocks in the default view. 2.As a developer, you can create multiple views or modify the default view. 3.This is useful for adding components that should be shown, regardless of how an editor assembles a page with blocks. 4.By default, the page doesn't display its contained items but only the title and blocks created by an editor. 5.To reveal contained items, you can create a listing block. 6.If you use a listing block without any specific criterias, it lists every contained items.

Vivek-04022001 avatar Jan 25 '24 13:01 Vivek-04022001

Thanks @Vivek-04022001 . Integrating your feedback in training documentation: #910

ksuess avatar Dec 22 '24 13:12 ksuess