website icon indicating copy to clipboard operation
website copied to clipboard

Where should visual aids be put for training materials and how should they be organised?

Open mahesh-panchal opened this issue 3 years ago • 3 comments

Is your feature request related to a problem? Please describe. There's no guidance where to put images/media for documentation and training guides.

Describe the solution you'd like Add instructions which folder images or other media is placed to training material guide and pipeline documentation, and describe how media from different pages should be organised within that folder, e.g naming, subfolder etc.

mahesh-panchal avatar Mar 18 '22 05:03 mahesh-panchal

Documentation about documentation, meta!

ewels avatar Apr 15 '22 13:04 ewels

Found a helpful blog post https://documatt.com/blog/2020/pictures-in-docs.html - where should this information be added @mahesh-panchal?

lukbut avatar Mar 28 '23 09:03 lukbut

Hi @lukbut , I'm currently on parental leave. As such, I'm not really available to work on issues at the moment.

This issue is more directed towards the website maintainers who dictate the folder structure. Last I knew, the website was getting a major overhaul, so the issue was left until that was finished. Perhaps @ewels , or @mashehu can provide better input on the state of things.

mahesh-panchal avatar Mar 28 '23 18:03 mahesh-panchal