Skip to content

docs: fix stale image paths in the contributing guide #1304

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.

Sign up for GitHub

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

Open
AllanBandeira91 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix stale image paths in the contributing guide #1304

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions frontend/docs/meta/Contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,11 @@ Don't use absolute URLs for inter-site links. Use relative paths.

### Images

Images go inside a subdirectory inside `/static/images`. Then when you link an image in a `![]()` you just use `/images/` as the base path (no need for `static` that's just for the repository).
Images that only the wiki needs go inside a subdirectory of `public/images`. Then when you link an image in a `![]()` you just use `/images/` as the base path (no need for `public`, that is just the repository directory).

If in doubt, read another page that uses images and copy how its done there.
Images shared across many pages (screenshots, icons, illustrations) are published to the CDN by the `upload-assets` task in `Taskfile.yml`, which copies `frontend/public/images` to `https://assets.open.mp/assets/images/`. Reference those with the full `https://assets.open.mp/assets/images/...` URL, as most pages in the wiki do.

If in doubt, read another page that uses images and copy how it's done there.

### Metadata

Expand Down
Loading