Skip to content
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.

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

add image-preferences blogpost #2520

Merged
merged 13 commits into from
Dec 9, 2024
Merged

Conversation

davidberenstein1957
Copy link
Member

@davidberenstein1957 davidberenstein1957 commented Dec 9, 2024

Congratulations! You've made it this far! Once merged, the article will appear at https://huggingface.co/blog. Official articles
require additional reviews. Alternatively, you can write a community article following the process here.

Preparing the Article

You're not quite done yet, though. Please make sure to follow this process (as documented here):

  • Add an entry to _blog.yml.
  • Add a thumbnail. There are no requirements here, but there is a template if it's helpful.
  • Check you use a short title and blog path.
  • Upload any additional assets (such as images) to the Documentation Images repo. This is to reduce bloat in the GitHub base repo when cloning and pulling. Try to have small images to avoid a slow or expensive user experience.
  • Add metadata (such as authors) to your md file. You can also specify guest or org for the authors.
  • Ensure the publication date is correct.
  • Preview the content. A quick way is to paste the markdown content in https://huggingface.co/new-blog. Do not click publish, this is just a way to do an early check.

Here is an example of a complete PR: #2382

Getting a Review

Please make sure to get a review from someone on your team or a co-author.
Once this is done and once all the steps above are completed, you should be able to merge.
There is no need for additional reviews if you and your co-authors are happy and meet all of the above.

Feel free to add @pcuenca as a reviewer if you want a final check. Keep in mind he'll be biased toward light reviews
(e.g., check for proper metadata) rather than content reviews unless explicitly asked.

image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
Copy link
Member

@sdiazlor sdiazlor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • What's the final intention? Community or dataset release? Depending on that, I'd shorten the title with a more straightforward one
  • I don't remember exactly where, but I recall some conversations mentioning that adding a short tldr section right at the beginning was useful for users to know what they can expect
  • Mention to https://huggingface.co/data-is-better-together-contributor?

image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
image-preferences.md Outdated Show resolved Hide resolved
Copy link
Member

@sayakpaul sayakpaul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this! Left a couple of comments.

update images with tinypng version
@davidberenstein1957
Copy link
Member Author

@Vaibhavs10 thanks, can you also merge it?

@Vaibhavs10 Vaibhavs10 merged commit 58cc00a into huggingface:main Dec 9, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants