Skip to content

Conversation

@LysandreJik
Copy link
Member

Mention that images shouldn't be added to the repository as it will otherwise significantly weigh down the repository.

example.
7. Due to the rapidly growing repository, it is important to make sure that no file that would significantly weigh down
the repository are added. This includes images, videos and other non-text files. We prefer to leverage a hf.co hosted `dataset` like
the ones hosted on [`hf-internal-testing`](https://huggingface.co/hf-internal-testing) in which to place these files and reference
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI the repo I use for documentation images is called "documentation-images": https://huggingface.co/datasets/huggingface/documentation-images

Copy link
Collaborator

@sgugger sgugger 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 adding this note. As said on another PR, I think it would be more efficient to couple this with a migration of existing images to the same dataset and completely remove the imgs folder, this way no one will be tempted to add an image.

Co-authored-by: NielsRogge <[email protected]>
@LysandreJik
Copy link
Member Author

WIll merge this as a first step!

@LysandreJik LysandreJik merged commit 6ac0fac into master Dec 13, 2021
@LysandreJik LysandreJik deleted the contributing-no-images branch December 13, 2021 17:21
@stas00
Copy link
Contributor

stas00 commented Dec 13, 2021

Merged too soon? We need a concrete destination for images that we all share.

@LysandreJik
Copy link
Member Author

@stas00
Copy link
Contributor

stas00 commented Dec 13, 2021

but it's not part of this PR that was merged. i.e. @NielsRogge's suggestion wasn't integrated into the doc.

additionally please please keep these instructions in docs/README.md - thank you!

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