You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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/>.
7
7
8
8
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.
9
9
@@ -13,12 +13,12 @@ We currently use the issue tracker for [Positron](https://github.com/posit-dev/p
13
13
14
14
## Linting
15
15
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.
17
17
18
18
- If you are a Posit employee, you can find the "Posit Documentation Style Guide" on Confluence.
19
19
- 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!
20
20
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.
22
22
23
23
## Local development
24
24
@@ -29,3 +29,7 @@ The configurations run `quarto preview` and then open the site in a new browser
29
29
-**Preview Docs (Edge)**: Preview the site in Edge
30
30
31
31
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