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

From Chunks to Blocks Blog Post #2659

Merged
merged 12 commits into from
Feb 12, 2025
Merged

From Chunks to Blocks Blog Post #2659

merged 12 commits into from
Feb 12, 2025

Conversation

jsulz
Copy link
Contributor

@jsulz jsulz commented Feb 7, 2025

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.

@jsulz jsulz requested review from ylow and pcuenca February 7, 2025 23:47
@jsulz
Copy link
Contributor Author

jsulz commented Feb 7, 2025

@pcuenca could you check this to make sure I've done my due diligence with metadata/folder structure? Thank you!!

(Also, if you're interested in reading it, I'll always take feedback ❤️ 😄 )

@jsulz jsulz requested a review from rajatarya February 11, 2025 19:02
@jsulz
Copy link
Contributor Author

jsulz commented Feb 11, 2025

@rajatarya I updated the intro and title to be a bit more in line with what you had discussed in Slack. Would love your feedback!

Planning on publishing this tomorrow morning.

Copy link
Member

@pcuenca pcuenca left a comment

Choose a reason for hiding this comment

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

Very cool! 🔥

assets/from-files-to-chunks/thumbnail.png Outdated Show resolved Hide resolved
from-chunks-to-blocks.md Outdated Show resolved Hide resolved
from-chunks-to-blocks.md Outdated Show resolved Hide resolved
from-chunks-to-blocks.md Outdated Show resolved Hide resolved
from-chunks-to-blocks.md Outdated Show resolved Hide resolved
from-chunks-to-blocks.md Outdated Show resolved Hide resolved
from-chunks-to-blocks.md Show resolved Hide resolved
from-chunks-to-blocks.md Outdated Show resolved Hide resolved
from-chunks-to-blocks.md Outdated Show resolved Hide resolved
@rajatarya
Copy link

@rajatarya I updated the intro and title to be a bit more in line with what you had discussed in Slack. Would love your feedback!

Planning on publishing this tomorrow morning.

Like the changes and pulling up the benefit callout into the intro paragraphs. Reads smoothly, looks good, let's go!

Copy link

@rajatarya rajatarya left a comment

Choose a reason for hiding this comment

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

Looks great, like the tone and flow of the post.

@jsulz jsulz merged commit 9af9e55 into main Feb 12, 2025
1 check passed
@jsulz jsulz deleted the jsulz/from-chunks-to-blocks branch February 12, 2025 16:12
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.

4 participants