Fix #527 mastering plone install clarification#994
Conversation
stevepiercy
left a comment
There was a problem hiding this comment.
Would you please follow this example?
https://6.docs.plone.org/contributing/documentation/myst-reference.html#enhance-media-label
|
Thank you for the reference. I updated the figure to follow the MyST example with a descriptive caption and alt text. Please let me know if further changes are needed. |
stevepiercy
left a comment
There was a problem hiding this comment.
Close, but not quite. Please see again the example I previously linked at https://6.docs.plone.org/contributing/documentation/myst-reference.html#enhance-media.
````{card}
```{image} /_static/caching/caching-disabled.png
:alt: Caching Control Panel
:target: /_static/caching/caching-disabled.png
```
+++
_Caching Control Panel_
````
|
Thanks for the reference. I updated the Site Setup figure to follow the enhanced media card pattern with image, alt text, target, and caption as shown in the MyST documentation example. Please let me know if any further changes are needed. |
|
Thanks for the reference. I have already updated the Site Setup figure to follow the enhanced media card pattern with image, alt text, target, and caption as shown in the MyST documentation example. Please let me know if any further changes are needed. |
stevepiercy
left a comment
There was a problem hiding this comment.
Did you check the link to the fullsize image? It doesn't work for me. What do you need to adjust?
Otherwise it's a nice improvement. Let's get this over the finish line!
docs/mastering-plone/add-ons.md
Outdated
| :target: _static/site_setup.png | ||
| ``` | ||
| +++ | ||
| _Plone Site Setup control panel with configuration options._ |
There was a problem hiding this comment.
| _Plone Site Setup control panel with configuration options._ | |
| _Plone Site Setup control panel showing available configuration options._ |
There was a problem hiding this comment.
Thanks for the review!
I’ve updated the enhanced media card to use absolute _static paths so the full-size image link works correctly, and aligned the caption wording with your suggestion.
Please let me know if everything looks good now.
There was a problem hiding this comment.
Please check https://plone-training--994.org.readthedocs.build/mastering-plone/add-ons.html#enabling-add-ons-in-your-plone-site. Now both the image and target values are incorrect.
Did you test locally first? This tricky to get right. It's best to use relative paths. I trust you'll figure it out.
There was a problem hiding this comment.
Image is restored, but the link to the full size image doesn't work.
There was a problem hiding this comment.
Thanks for your patience. I updated the image target to use an absolute /_static/ path and verified that clicking the image now opens the full-size version on ReadTheDocs. Please let me know if anything else needs adjustment.
There was a problem hiding this comment.
The latest change broke both the image display and the link to download the full size image.
There was a problem hiding this comment.
Removed stray example block and aligned enhanced media card with Sphinx root static paths. Image and full-size link now resolve correctly.
There was a problem hiding this comment.
Pls do let me know if this time everything is fine or not so that I will do some more changes and adjustments if required
There was a problem hiding this comment.
@Sneha-Goswami123 image is still broken and returns a 404.
Wait for the build to complete on RTD and verify that both the image displays and the image is not a 404 when clicked. If and only if you have resolved both parts, then please ask for a review. It doesn't make sense to ask for a review when it clearly doesn't show the image and it 404s.
There was a problem hiding this comment.
Hi @stevepiercy,
I have verified after the latest RTD build:
• The image displays correctly on the page
• Clicking the image opens the full-size file (1200×900)
• No 404 occurs
Tested here:
https://plone-training--994.org.readthedocs.build/mastering-plone/add-ons.html#enabling-add-ons-in-your-plone-site
Could you please review again? Thank you for your patience!
stevepiercy
left a comment
There was a problem hiding this comment.
Revert stray space you added.
docs/mastering-plone/add-ons.md
Outdated
| :target: _static/site_setup.png | ||
| ``` | ||
| +++ | ||
| _Plone Site Setup control panel with configuration options._ |
There was a problem hiding this comment.
@Sneha-Goswami123 image is still broken and returns a 404.
Wait for the build to complete on RTD and verify that both the image displays and the image is not a 404 when clicked. If and only if you have resolved both parts, then please ask for a review. It doesn't make sense to ask for a review when it clearly doesn't show the image and it 404s.
|
Hi @stevepiercy, I have verified after the latest RTD build: • The image displays correctly on the page Tested here: Could you please review again? Thank you for your patience! |
stevepiercy
left a comment
There was a problem hiding this comment.
Now that the image is displayed, and clicking it no longer results in a 404 (congratulations!), the alt text and caption should align with the image and its introductory text above the image. Would you please make the suggested changes? Thank you!
Added descriptive alt text to the Site Setup figure to improve accessibility and documentation quality.
📚 Documentation preview 📚: https://plone-training--994.org.readthedocs.build/