Marketplace #239
Marketplace #239
Conversation
Updated the Upload guide
WalkthroughThe pull request involves updates to two documentation files in the marketplace section. The first document, a guide for uploading files, has been restructured with step renumbering and content consolidation. The second document focuses on order statuses, introducing terminology changes and clarifying descriptions for various order states, including replacing "New" with "In Queue" and adding a new "Ready" status for Fine-tune orders. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/marketplace/guides/upload.md (3)
53-53: Fix grammatical error in preposition usageChange "place them to the model directory" to "place them in the model directory" for correct preposition usage.
-Create a directory for the model files—the model directory. Select files following the instructions for your model format and place them to the model directory. +Create a directory for the model files—the model directory. Select files following the instructions for your model format and place them in the model directory.🧰 Tools
🪛 LanguageTool
[uncategorized] ~53-~53: The preposition ‘in’ seems more likely in this position.
Context: ...ns for your model format and place them to the model directory. If multiple forma...(AI_HYDRA_LEO_REPLACE_TO_IN)
Line range hint
87-178: Add security validation step for archive contentsConsider adding a security validation step to ensure the archive doesn't contain potentially harmful files or unexpected content. This is particularly important as these files will be deployed in a production environment.
Add a note about security validation after the archive creation instructions:
:::caution Before uploading, verify that your archive contains only the intended model files. Remove any temporary files, development artifacts, or system-specific hidden files that might have been inadvertently included. :::
Line range hint
179-224: Add practical considerations for large file uploadsThe upload section should include information about upload size limits, expected upload times, and timeout considerations. This is especially important given the 10GB model size limit mentioned earlier.
Add a note about upload considerations:
:::tip For large models: - Ensure stable internet connection during upload - Upload times may vary depending on your connection speed - The upload process might take several minutes for files close to the 10GB limit - Do not refresh the page during upload :::docs/marketplace/orders/order/index.md (1)
22-33: Add status transition diagram for clarityConsider adding a visual representation of the status flow to help users understand how orders progress through different states. This is particularly important with the introduction of the new "Ready" status for Fine-tune orders.
Add a mermaid diagram showing the status transitions. For example:
```mermaid stateDiagram-v2 [*] --> Suspended Suspended --> Blocked Blocked --> InQueue InQueue --> Processing Processing --> Deployed: Deploy orders Processing --> Ready: Fine-tune orders Deployed --> Done Ready --> Done</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 8ca5c4f27bb659392466f73fba9857d990bff410 and 8547483f2b70c066631698222508a5d8c02ce700. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `docs/marketplace/guides/upload.md` (3 hunks) * `docs/marketplace/orders/order/index.md` (3 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>docs/marketplace/guides/upload.md</summary> [uncategorized] ~53-~53: The preposition ‘in’ seems more likely in this position. Context: ...ns for your model format and place them to the model directory. If multiple forma... (AI_HYDRA_LEO_REPLACE_TO_IN) </details> </details> </details> <details> <summary>🔇 Additional comments (2)</summary><blockquote> <details> <summary>docs/marketplace/orders/order/index.md (2)</summary> `37-39`: **LGTM! Improved error handling and consistent spelling** The changes improve error handling by providing a clear troubleshooting path, and maintain consistent American English spelling with "Canceling". --- `43-43`: **LGTM! Clear and consistent updates** The changes provide better clarity on lease remaining calculations, offline status implications, and button visibility rules. The updates maintain consistency with the new terminology throughout the document. Also applies to: 61-61, 71-71 </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Updated the Upload guide
Summary by CodeRabbit
Release Notes
Documentation
Improvements