Skip to content

Improve discoverability of environment variables documentation #1906

Open
cwickham wants to merge 2 commits intoprereleasefrom
issue/12896
Open

Improve discoverability of environment variables documentation #1906
cwickham wants to merge 2 commits intoprereleasefrom
issue/12896

Conversation

@cwickham
Copy link
Collaborator

@cwickham cwickham commented Feb 24, 2026

  • Renames pages to distinguish between them:
    • "Project Environment Variables" — the _environment file
      feature. Keeps nav label as "Environment Variables" for brevity
    • "Quarto Environment Variables" — env vars Quarto reads/sets
  • Adds callout to the project page linking to the Quarto env vars reference

Closes quarto-dev/quarto-cli#12896

@cwickham cwickham requested a review from cderv February 24, 2026 21:19
@cwickham cwickham marked this pull request as ready for review February 24, 2026 21:19
@github-actions github-actions bot temporarily deployed to pull request February 24, 2026 21:20 Inactive
@github-actions
Copy link
Contributor

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-1906.quarto.org

🔄 Modified Documents

Copy link
Collaborator

@cderv cderv left a comment

Choose a reason for hiding this comment

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

Callout is nice !

I wonder if we should have one for the other way.

Also did you consider listing the Quarto Environment variable page in

            - section: "Advanced"
              contents:
                - docs/authoring/includes.qmd
                - docs/authoring/variables.qmd
                - docs/output-formats/page-layout.qmd
                - docs/authoring/language.qmd
                - docs/authoring/conditional.qmd
                - docs/extensions/nbfilter.qmd
                - section: "Jupyter"
                  contents:
                    - docs/advanced/jupyter/kernel-execution.qmd

I think it could help too, but maybe you considered the callout would be enough. Which make sense in a way, but asking to confirm it was a choice.

@cwickham
Copy link
Collaborator Author

@cderv Yeah, we link in the text, but a callout might be more visible. It was intentional not to list in the Advanced section of the sidebar. I think I want to resurrect #1197, which separates the pages that are advanced authoring features (shortcodes, conditional content, etc.), from those that are docs for advanced use of Quarto beyond authoring .qmd (the things on https://quarto.org/docs/advanced/).

Copy link
Collaborator

@cderv cderv left a comment

Choose a reason for hiding this comment

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

Make sense. Thanks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants