Skip to content

Commit 429adee

Browse files
committed
Update REAMDE for freeze execution option
1 parent ed82e55 commit 429adee

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Netlify Status](https://api.netlify.com/api/v1/badges/2567d399-328e-4f0f-9784-c14cbe238fb7/deploy-status)](https://app.netlify.com/sites/positron-posit-co/deploys)
44
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" height = 20 /></a>
55

6-
This is the repo for the Positron website at <https://positron.posit.co/>.
6+
This is the repo for the Positron website at <https://positron.posit.co/>.
77

88
This site is built with [Quarto](https://quarto.org/) and the [Posit product documentation theme](https://github.com/posit-dev/product-doc-theme), and these educational materials are released under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/). Positron™ and the Positron icon™ are trademarks of Posit Software, PBC. All rights reserved.
99

@@ -13,12 +13,12 @@ We currently use the issue tracker for [Positron](https://github.com/posit-dev/p
1313

1414
## Linting
1515

16-
This project uses [Vale](https://vale.sh/docs/) for automated linting and compliance with the Posit style guide.
16+
This project uses [Vale](https://vale.sh/docs/) for automated linting and compliance with the Posit style guide.
1717

1818
- If you are a Posit employee, you can find the "Posit Documentation Style Guide" on Confluence.
1919
- If you are an external contributor, we as reviewers will take responsibility for compliance with the guidelines. Thank you for being willing to improve our docs!
2020

21-
Vale runs [via GH action on PRs](https://github.com/posit-dev/positron-website/actions/workflows/lint.yml), but you can also run it locally before you submit a PR if you have [installed Vale](https://vale.sh/docs/vale-cli/installation/) locally. Run `vale .` from the root directory of this project to lint the `.qmd` files used to build to site.
21+
Vale runs [via GH action on PRs](https://github.com/posit-dev/positron-website/actions/workflows/lint.yml), but you can also run it locally before you submit a PR if you have [installed Vale](https://vale.sh/docs/vale-cli/installation/) locally. Run `vale .` from the root directory of this project to lint the `.qmd` files used to build the site.
2222

2323
## Local development
2424

@@ -29,3 +29,7 @@ The configurations run `quarto preview` and then open the site in a new browser
2929
- **Preview Docs (Edge)**: Preview the site in Edge
3030

3131
The site will re-render as you make changes to the `.qmd` files.
32+
33+
## Managing execution and rendering
34+
35+
Some `.qmd` files used for our site involve executable code, like the `.qmd` file that creates <https://positron.posit.co/download>. We currently use the ["Local Execution with CI Rendering" option described in the Quarto docs](https://quarto.org/docs/publishing/ci.html#rendering-for-ci), with the [freeze](https://quarto.org/docs/projects/code-execution.html#freeze) execution option to make it easier for us to collaborate together across the large number of pages. For now, if you need to update a page involving computations, be sure to render that page locally and check in the files created in the `_freeze` directory.

0 commit comments

Comments
 (0)