docs: add Infrahub Marketplace page#9366
Open
yjouffrault wants to merge 1 commit into
Open
Conversation
Integrates the Marketplace docs from PR #9093 into the revamped docs structure using the single-page merge pattern: - New `schema/marketplace/index.mdx` — merges the original topic and how-to guide into one page covering what the Marketplace is, how identifiers and versioning work, and the full fetch+load workflow (including version pinning, --stdout, and collection variants) - Sidebar: Marketplace added to Schema & Data → Schema operations - Replaces all Schema Library (github.com/opsmill/schema-library) references with Marketplace links across concepts, quickstart, next-steps, schema extensions, tutorials, and install pages - Adds "Load a schema" + Marketplace tip to community and enterprise install pages (the file that PR #9093 targeted has since moved) - Adds stderr/stdin/stdout to Vale spelling exceptions - Adds redirects-pending/marketplace.yml for URL redirect tracking Original content authored by Alex Gao. Closes #9093. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
1 issue found across 12 files
Confidence score: 4/5
- This PR looks safe to merge overall, with only a minor documentation consistency risk rather than a runtime/code regression risk.
- In
docs/docs/overview/quickstart.mdx, dropping theuv runprefix oninfrahubctlexamples can mislead users in uv-managed Copier-template setups, potentially causing quickstart commands to fail or behave unexpectedly. - Given the issue is severity 4/10 and limited to docs usage guidance, the merge risk is minimal but worth a follow-up correction for smoother onboarding.
- Pay close attention to
docs/docs/overview/quickstart.mdx- ensureinfrahubctlcommand prefixes are consistent with the rest of the quickstart instructions.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/docs/overview/quickstart.mdx">
<violation number="1" location="docs/docs/overview/quickstart.mdx:90">
P2: The `infrahubctl` commands here dropped the `uv run` prefix that is consistently used for every other `infrahubctl` command in this document. In a uv-managed project created by the Copier template, these commands may fail with "command not found" when the user follows the tutorial.</violation>
</file>
Shadow auto-approve: would not auto-approve because issues were found.
Re-trigger cubic
|
|
||
| ```bash | ||
| uv run invoke schema-library-get | ||
| infrahubctl marketplace get opsmill/dcim |
Contributor
There was a problem hiding this comment.
P2: The infrahubctl commands here dropped the uv run prefix that is consistently used for every other infrahubctl command in this document. In a uv-managed project created by the Copier template, these commands may fail with "command not found" when the user follows the tutorial.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/docs/overview/quickstart.mdx, line 90:
<comment>The `infrahubctl` commands here dropped the `uv run` prefix that is consistently used for every other `infrahubctl` command in this document. In a uv-managed project created by the Copier template, these commands may fail with "command not found" when the user follows the tutorial.</comment>
<file context>
@@ -80,31 +80,30 @@ You should see the Infrahub web interface with a navigation menu on the left sid
```bash
-uv run invoke schema-library-get
+infrahubctl marketplace get opsmill/dcim
</file context>
</details>
```suggestion
uv run infrahubctl marketplace get opsmill/dcim
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
schema/marketplace/index.mdx: single-page merge of the original topic + how-to guide. Covers what the Marketplace is, namespace/name identifiers, semantic versioning, and the full fetch+load workflow (infrahubctl marketplace get→infrahubctl schema load) including version pinning,--stdout, and collection variantsgithub.com/opsmill/schema-libraryreferences with Marketplace links: overview/concepts, overview/quickstart, overview/next-steps, schema/extensions, tutorials/getting-started/schemaguides/installation.mdxhas since moved to these two files)stderr/stdin/stdoutto Vale spelling exceptionsredirects-pending/marketplace.ymlfor URL tracking (will be aggregated at cleanup)Why a new PR instead of merging #9093
PR #9093 was created before the docs revamp shipped. It adds content to
topics/andguides/paths that no longer exist, and uses the old sidebar structure. This PR applies the same content to the correct new locations.Test plan
cd docs && npm run builduv run invoke docs.lint/schema/marketplace/— page renders with concept intro and full workflow🤖 Generated with Claude Code