-
Notifications
You must be signed in to change notification settings - Fork 477
Add Blog Articles docs and updates #2484
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8f5046d
Add Blog Articles docs
mishig25 2d3014e
Update docs/hub/blog-articles.md
mishig25 b61e6c9
Drop custom-role and WriteBlog mentions from blog articles doc
mishig25 17a287c
Dedupe linking section; reference canonical blog-articles doc
mishig25 00b9df7
Update docs/hub/blog-articles.md
mishig25 a43876b
Add screenshots to blog articles doc
mishig25 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Blog Articles | ||
|
|
||
| Blog Articles let you publish long-form content directly on the Hub — model releases, research updates, tutorials, and announcements — and share them with the broader community. Articles can be published under your personal namespace or under an [organization](./organizations) you belong to. | ||
|
|
||
| ## Who Can Publish Blog Articles | ||
|
|
||
| To publish under **your personal namespace**, you need a confirmed email and must satisfy at least one of the following: | ||
|
|
||
| - You have an active [PRO](./pro) subscription. | ||
| - You are a member of a [Team or Enterprise](https://huggingface.co/enterprise) organization (with `write` or `admin` role in that organization). | ||
|
|
||
| Managed users (users provisioned through Enterprise IdP) cannot publish under their personal namespace. | ||
|
|
||
| To publish under an **organization namespace**, both must hold: | ||
|
|
||
| - The organization is on the [Team or Enterprise](https://huggingface.co/enterprise) plan. | ||
| - You have the `write` or `admin` role in that organization. See [Access Control in Organizations](./organizations-security) for more on roles. | ||
|
|
||
| See [Blog Articles for Organizations](./enterprise-blog-articles) for organization-specific details. | ||
|
|
||
| ## Creating a Blog Article | ||
|
|
||
| Go to [huggingface.co/new-blog](https://huggingface.co/new-blog) to start a new article. You can write in Markdown, embed media, and reference models, datasets, and Spaces hosted on the Hub. | ||
|
|
||
| When creating the article, pick the namespace it should be published under from the dropdown: | ||
|
|
||
| - **Your username** — the article appears on your user profile. | ||
| - **An organization** — the article appears on that organization's profile page. | ||
|
|
||
| <div class="flex justify-center"> | ||
| <img class="block dark:hidden" width="550" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/blog-creation-editor.png"/> | ||
| <img class="hidden dark:block" width="550" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/blog-creation-editor-dark.png"/> | ||
| </div> | ||
|
|
||
| ## Editing an Article | ||
|
|
||
| - Articles published under a user namespace can be edited by the original author and any coauthors listed on the article. | ||
| - Articles published under an organization namespace can be edited by any organization member with `write` or `admin` role. | ||
|
|
||
| ## Linking to Models and Datasets | ||
|
|
||
| When a blog article mentions a model or dataset, and the article's author (user or organization) is the same as the repo's owner, the article will automatically appear in the sidebar of that model or dataset page under **"Article(s) mentioning [repo-id]"**. Up to three of the most recent matching articles are shown. | ||
|
|
||
| <div class="flex justify-center"> | ||
| <img class="block dark:hidden" width="350" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/blog-articles-mentioning-sidebar.png"/> | ||
| <img class="hidden dark:block" width="350" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/blog-articles-mentioning-sidebar-dark.png"/> | ||
| </div> | ||
|
|
||
| This makes it easy for visitors to discover related write-ups, release announcements, and research notes alongside the repository itself. | ||
|
|
||
| If the article references a [Collection](./collections), every model and dataset in that collection is treated as linked — the article will surface on each member repo's page (subject to the same ownership rule). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.