decaporg / decaporg/decap-website

Improve media_folder and public_folder documentation

Open
#8 3 comments 5 reactions 0 assignees View on GitHub
documentation
Dominant language
SCSS
Stars
13
Forks
319
Avg merge
6d 3h
Merged PRs (30d)
1

Description

When https://www.netlifycms.org/docs/beta-features/#folder-collections-media-and-public-folder was introduced the main intended use case was to allow saving media files in the same folder as the entry under the constraint different entries don't share media files.
Since then we've added support for specifying per collection and per field `media_folder` and `public_folder`. We also allow `media_folder` to be either a relative path or an absolute path which can cause confusion: https://github.com/netlify/netlify-cms/issues/3654#issuecomment-620423495.
We've also added templating and cascading for `media_folder` and `public_folder` which is not documented at all (https://github.com/netlify/netlify-cms/issues/3670#issuecomment-620422267).
We should document all of these changes and provide examples for each scenario.

### Important
Make it clear to what the `media_folder` is used for (specifying where to save the file in the repo) and what `public_folder` is used for (specifying how to output the file path in the frontmatter).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.