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

Plone Training Guide for Content Editors #896

Merged
merged 16 commits into from
Dec 9, 2024

Conversation

tkimnguyen
Copy link
Member

@tkimnguyen tkimnguyen commented Dec 5, 2024

This is the training guide we used at the 2024 conference class.

Remaining to do:

  • Rather than refer to screenshots saved on S3, save them to the repo and update the links
  • Add card to enhance images with alt text

Also see issue with other additions to the guide: #899


📚 Documentation preview 📚: https://plone-training--896.org.readthedocs.build/

@ericof ericof self-requested a review December 5, 2024 19:52
@tkimnguyen tkimnguyen requested a review from spereverde December 5, 2024 20:06
Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

I reviewed only index.md and the first page under the Files changed tab, add-a-file.md. Changes to index.md are required. Changes to add-a-file.md are optional except for one mandatory item, but would improve accessibility with semantic markup. If you choose to do them across all the files, you will get many 🤗 from accessibility allies and will make your docs prettier.

I see you have a todo to copy images into this repo. I have a serious concern about remote content, as it can "go away" or be unreachable without an Internet connection.

docs/content-editing/index.md Outdated Show resolved Hide resolved
docs/content-editing/index.md Outdated Show resolved Hide resolved
docs/content-editing/index.md Show resolved Hide resolved
docs/content-editing/index.md Outdated Show resolved Hide resolved
docs/content-editing/index.md Outdated Show resolved Hide resolved
docs/content-editing/add-a-file.md Outdated Show resolved Hide resolved
docs/content-editing/add-a-file.md Outdated Show resolved Hide resolved
docs/content-editing/add-a-file.md Outdated Show resolved Hide resolved
docs/content-editing/index.md Outdated Show resolved Hide resolved
docs/content-editing/add-a-file.md Outdated Show resolved Hide resolved
Copy link
Member

@spereverde spereverde left a comment

Choose a reason for hiding this comment

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

Nicely written, thanks for writing all that up!

@tkimnguyen tkimnguyen merged commit a324d46 into main Dec 9, 2024
2 of 3 checks passed
@tkimnguyen tkimnguyen deleted the 20241203-tkn-editor-training branch December 9, 2024 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants