docs: add concepts of targets #917
Conversation
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #917 +/- ##
==========================================
- Coverage 80.24% 80.19% -0.05%
==========================================
Files 63 63
Lines 6053 6053
==========================================
- Hits 4857 4854 -3
- Misses 858 860 +2
- Partials 338 339 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
PR Overview
This PR adds a new documentation file that explains the concepts of targets in oras-go v2, including relevant interfaces, content stores, and usage diagrams.
- Introduces the Targets documentation with detailed explanations and examples.
- Provides diagrams and tables that illustrate the structure and functionality of various content stores.
Reviewed Changes
| File | Description |
|---|---|
| docs/Targets.md | New documentation covering targets, interfaces, and content stores |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (3)
docs/Targets.md:302
- The word 'Funciton' is misspelled; it should be 'Function'.
| Funciton Name | API endpoint |
docs/Targets.md:312
- The word 'Funciton' is misspelled; it should be 'Function'.
| Funciton Name | API endpoint |
docs/Targets.md:326
- The word 'arbitary' is misspelled; it should be 'arbitrary'.
| File Store | Stores location-addressable content on file system | Partial (For named blobs only) | Yes | Packaging arbitary files |
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
There was a problem hiding this comment.
PR Overview
This pull request adds comprehensive documentation for the new concepts of Targets in oras-go v2 by explaining various interfaces, content stores, and providing visual diagrams.
- Added documentation outlining the interfaces (Storage, GraphStorage, Target, GraphTarget) and their functionalities.
- Provided detailed examples and diagrams for the implemented content stores (Memory, OCI, File, and Repository).
- Included a flowchart to help users choose the appropriate content store.
Reviewed Changes
| File | Description |
|---|---|
| docs/Targets.md | Detailed documentation for Targets, including interface definitions and examples |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
There was a problem hiding this comment.
PR Overview
This PR adds documentation to explain the concepts of targets and content stores in oras-go v2. It introduces a new doc file with detailed explanations, examples including mermaid diagrams, and usage guidelines for the built-in content stores.
Reviewed Changes
| File | Description |
|---|---|
| docs/Targets.md | New documentation detailing targets and content stores in oras-go v2 |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
There was a problem hiding this comment.
PR Overview
This PR adds comprehensive documentation covering Targets and various content store concepts in oras-go v2. It introduces detailed descriptions of interfaces, usage examples with JSON and mermaid diagrams, and practical guidance for selecting the appropriate content store.
Reviewed Changes
| File | Description |
|---|---|
| docs/Targets.md | New documentation detailing Targets, Storage, and content stores |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
|
Thanks @TerryHowe for the review! I addressed your comments, please take a look again. |
There was a problem hiding this comment.
PR Overview
This PR adds detailed documentation for the targets and content store concepts introduced in oras-go v2.
- Introduces an overview of the four primary interfaces for storage and targets.
- Provides comprehensive examples, including JSON snippets, Mermaid diagrams, and command-line outputs to illustrate different content store scenarios.
Reviewed Changes
| File | Description |
|---|---|
| docs/Targets.md | New documentation covering targets, graph storage, and various content store types |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Resolves: #814