Skip to content

feat(ENG-9724): update generic docs#313

Merged
poconnor-cloud merged 19 commits into
mainfrom
eng_9724
Feb 3, 2026
Merged

feat(ENG-9724): update generic docs#313
poconnor-cloud merged 19 commits into
mainfrom
eng_9724

Conversation

@poconnor-cloud
Copy link
Copy Markdown
Contributor

Add docs outlining our support for Generic format

Copilot AI review requested due to automatic review settings January 26, 2026 09:51
@vercel
Copy link
Copy Markdown

vercel Bot commented Jan 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cloudsmith-docs Ready Ready Preview, Comment Jan 30, 2026 2:16pm

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for Cloudsmith's Generic format support, enabling users to store and manage arbitrary files using path-based identification.

Changes:

  • Added new Generic format documentation covering upload, download, HTML/JSON indexing, upstream proxying, and GPG signing
  • Added Generic menu entry in the documentation navigation (correctly positioned alphabetically between Docker and Go)
  • Cleaned up trailing whitespace in menu.json for improved code quality

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/content/menu.json Added Generic format menu entry and removed trailing whitespace throughout the file
src/content/formats/generic-repository.mdx New comprehensive documentation for Generic format including CLI/web upload, public/private download instructions, HTML/JSON indexing, upstream proxying configurations, and GPG signing support

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@poconnor-cloud
Copy link
Copy Markdown
Contributor Author

Just need to update the upstreams/index and should be good to go

Comment thread src/content/menu.json
Comment thread src/content/formats/generic-repository.mdx
Comment thread src/content/formats/generic-repository.mdx
Comment thread src/content/formats/generic-repository.mdx Outdated
Comment thread src/content/formats/generic-repository.mdx
Comment thread src/content/formats/generic-repository.mdx Outdated
Comment thread src/content/formats/generic-repository.mdx Outdated
Comment thread src/content/formats/generic-repository.mdx Outdated
@apoclyps
Copy link
Copy Markdown
Contributor

Example of what we added for the HuggingFace Format & Conda upstreams when they were added as new that we can use to check we include everything necessary:

@poconnor-cloud
Copy link
Copy Markdown
Contributor Author

Updated the above with a screenshot from the new web-ui @apoclyps

Comment thread src/content/formats/generic-repository.mdx Outdated
Comment thread src/content/formats/generic-repository.mdx
@paulmay-cloudsmith
Copy link
Copy Markdown
Collaborator

Hey there; could this text be moved up to just after the heading, used as an introduction?

Generic upstreams work with simple HTML-based sources. The upstream must consist of simple, unstyled HTML pages with no JavaScript. Each page should contain only links to package files or subdirectories. Examples include Gradle distributions, Apache releases, and Node distributions.

Comment thread src/content/formats/generic-repository.mdx Outdated
Comment thread src/content/formats/generic-repository.mdx
@paulmay-cloudsmith
Copy link
Copy Markdown
Collaborator

Is this ready to go?

@apoclyps
Copy link
Copy Markdown
Contributor

apoclyps commented Feb 2, 2026

Is this ready to go?

Just a few more people to get some eyes on it. Enablement meeting happening later today so aiming to have this ready to go ASAP.

Comment thread src/content/formats/generic-repository.mdx
@poconnor-cloud poconnor-cloud merged commit 8219155 into main Feb 3, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

5 participants