Start here

Open Beginner friendly
#1 157 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Start with the numbered instructions in this issue and compare them with the linked example PR at github/blog#5321. The documented workflow is complete when an asset URL can be copied, verified in a browser, and used in an external-facing changelog, with videos in MP4 format.

Written by the indexing model from the issue text.

Description

Note: steps have been updated recently.

Use this issue to generate links to publicly-accessible assets like images and videos. You can use these links in changelog posts and any other external-facing resources.

To generate an external-safe link:

  1. Drag the image/ video file into a comment below (or click "Attach files 📎"). Note: Changelog posts require the videos to be in MP4 format.
  2. A URL will appear in the comment this format: ![Image](https://github.com/github/release-assets/assets/2180038/1a5ae48b-e85a-4fbf-a8d0-55378c12dff6)
  3. Copy that entire link and update 'image' with a description of the image, then paste that link into your changelog draft. You can confirm the image loads by opening the URL by itself in a browser tab.
  4. Do not save your comment. Copy the generated URL, verify it works, and then close the issue without saving your changes.

Example PR with image embedded properly: https://github.com/github/blog/pull/5321/files

Dominant language
No language data
Stars
16
Forks
2
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/release-assets

All issues in github/release-assets

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.