Repository navigation
docs: document installed extension layout and qualified names - #2303
Merged
Merged
Conversation
…ied names The install namespace rule was only written down in an unpublished draft, and "Archive Distribution" said every archive shares a single namespace, which is not true for GitHub archive URLs. Extension authors kept shipping an owner folder in their source `_extensions/`, which Quarto drops at install time, and templates referencing a qualified format name then broke when used from a local copy (quarto-dev/quarto-cli#15111). Document what quarto-cli does: - installs land in `_extensions/<owner>/<name>/`, where the owner is the GitHub owner the extension is installed from; other URLs, local archives and local directories install as `_extensions/<name>/` - source repos put extensions directly under `_extensions/`, and extensions from another owner are bundled with `quarto add --embed` - a qualified `<owner>/<name>` selects by installed owner, so a shipped `template.qmd` should use the bare name - the install-time note from quarto-dev/quarto-cli#15117 (1.11) Also replace the stale `quarto install` wording in starter-templates.
Contributor
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2303.quarto.org 🔄 Modified Documents |
Make the GitHub owner condition explicit and simplify the embedding instructions so readers can follow the required order. Shorten the installation summary while preserving the documented paths.
…ng note The host extension's _extension.yml only resolves filters and shortcodes from its own embedded _extensions/, so an extension installed at the project level still fails the check until it is embedded.
Contributor
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2303.quarto.org 🔄 Modified Documents |
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.
Follow-up to quarto-dev/quarto-cli#15111. Extensions are installed under
_extensions/<owner>/<name>/, where the owner is the GitHub owner the extension is installed from. Archives and local directories have no owner and install as_extensions/<name>/.This was only written in the unpublished draft
docs/journals/_draft/create-extensions.qmd, which also shows an owner folder in the source layout. Quarto drops that folder at install time. Several extension repositories ship_extensions/<owner>/<name>/anyway, and atemplate.qmdusing a qualified format name then fails when the template is used from a local copy.docs/extensions/distributing.qmdnow covers:<owner>/<name>and bare names match, and using the bare name in atemplate.qmdshipped with an extensionquarto add --embedfor bundling an extension from another owner, which was only in the CLI reference until nowAlso
quarto installis replaced byquarto addinstarter-templates.qmd, andmanaging.qmdnow shows the installed paths.Each statement was checked against quarto-cli source (
src/extension/install.ts,extension-host.ts,extension.ts) and with real installs in 1.11: GitHub repository, GitHub archive URL, local directory, and--embed.Related to quarto-dev/quarto-cli#15111