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
Remove posit-cloud as a publishing venue (#1792) (#1795)
* Remove `posit-cloud` as a publishing venue
* Link to other venues
* Remove from 1.4 sidebar too
(cherry picked from commit c3d19c6)
Co-authored-by: Charlotte Wickham <charlotte.wickham@posit.co>
Copy file name to clipboardExpand all lines: docs/output-formats/html-publishing.qmd
-1Lines changed: 0 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,6 @@ Here's a brief overview of the various supported services and when they might be
30
30
|[Quarto Pub](/docs/publishing/quarto-pub.qmd)| Publishing service for Quarto documents, websites, and books. Use Quarto Pub when you want a free, easy to use service for publicly available content. |
31
31
|[GitHub Pages](/docs/publishing/github-pages.qmd)| Publish content based on source code managed within a GitHub repository. Use GitHub Pages when the source code for your document or site is hosted on GitHub. |
32
32
|[Posit Connect](/docs/publishing/rstudio-connect.qmd)| Publishing platform for secure sharing of data products within an organization. Use Posit Connect when you want to publish content within an organization rather than on the public internet. |
33
-
|[Posit Cloud](/docs/publishing/posit-cloud.qmd)| Create data projects and publish results from your web browser. Use Posit Cloud when you want to organize all your static documents and interactive applications in one place. |
34
33
|[Netlify](/docs/publishing/netlify.qmd)| Professional web publishing platform. Use Netlify when you want support for custom domains, authentication, previewing branches, and other more advanced capabilities. |
35
34
|[Other Services](/docs/publishing/other.qmd)| Content rendered with Quarto uses standard formats (HTML, PDFs, MS Word, etc.) that can be published anywhere. Use this if one of the methods above don't meet your requirements. |
Copy file name to clipboardExpand all lines: docs/publishing/_providers.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,6 @@
5
5
|[Quarto Pub](/docs/publishing/quarto-pub.qmd)| Publishing service for Quarto documents, websites, and books. Use Quarto Pub when you want a free, easy to use service for publicly available content. |
6
6
|[GitHub Pages](/docs/publishing/github-pages.qmd)| Publish content based on source code managed within a GitHub repository. Use GitHub Pages when the source code for your document or site is hosted on GitHub. |
7
7
|[Posit Connect](/docs/publishing/rstudio-connect.qmd)| Publishing platform for secure sharing of data products within an organization. Use Posit Connect when you want to publish content within an organization rather than on the public internet. |
8
-
|[Posit Cloud](/docs/publishing/posit-cloud.qmd)| Create data projects and publish results from your web browser. Use Posit Cloud when you want to organize all your static documents and interactive applications in one place. |
9
8
|[Netlify](/docs/publishing/netlify.qmd)| Professional web publishing platform. Use Netlify when you want support for custom domains, authentication, previewing branches, and other more advanced capabilities. |
10
9
|[Confluence](/docs/publishing/confluence.qmd)| Publishing platform for supporting team collaboration. Use Confluence to share documents in team Spaces. |
11
10
|[Hugging Face Spaces](/docs/publishing/hugging-face.qmd)| Publishing platform specializing in learning models and datasets. Use Hugging Face Spaces when you want to share Quarto documents together with associated machine learning models and/or datasets. |
Copy file name to clipboardExpand all lines: docs/publishing/posit-cloud.qmd
+5-320Lines changed: 5 additions & 320 deletions
Original file line number
Diff line number
Diff line change
@@ -6,327 +6,12 @@ heading-pad: '#'
6
6
7
7
{{< include /docs/_require-1.4.qmd >}}
8
8
9
-
## Overview
9
+
::: callout-caution
10
10
11
-
On [Posit Cloud](https://posit.cloud), you can create data projects and publish results from your web browser. Use Posit Cloud when you want to organize all your static documents and interactive applications in one place.
11
+
Publishing to Posit Cloud is deprecated as of Quarto 1.8.
12
+
Please see <https://docs.posit.co/cloud/whats_new/#october-2024>
12
13
13
-
There are several ways to publish Quarto content to Posit Cloud:
14
+
See [Publishing Basics](index.qmd) for alternative publishing venues.
14
15
15
-
1. Use the `quarto publish` command to publish static content rendered on your local machine.
16
+
:::
16
17
17
-
2. Use the [rsconnect-python](https://docs.posit.co/rsconnect-python/) Python package or [rsconnect](https://rstudio.github.io/rsconnect/) R package to publish code for rendering on Posit Cloud.
18
-
19
-
3. Use a Continuous Integration (CI) service like [Jenkins](https://www.jenkins.io/), [Airflow](https://airflow.apache.org/), or [GitHub Actions](https://docs.github.com/en/actions), to render and publish to Posit Cloud.
20
-
21
-
Each of these options is covered in detail below. If you are just getting started, we strongly recommend using the first approach (`quarto publish`). Then, as your needs evolve, you can consider other more sophisticated options.
22
-
23
-
## Publish Command
24
-
25
-
The `quarto publish` command is the easiest way to publish locally rendered content. From the directory where your project is located, execute the `quarto publish` command for Posit Cloud:
26
-
27
-
```{.bash filename="Terminal"}
28
-
quarto publish posit-cloud
29
-
```
30
-
31
-
If you haven't previously published to Posit Cloud you'll be prompted to enter your token and token secret (available under Account > Tokens):
After authenticating, your content will be rendered and published, and then a browser will open to view its page on Posit Cloud.
40
-
41
-
A record of your previous publishes will be stored in a `_publish.yml` file within the project or document directory. This file stores the service, id, and URL of the published content. For example:
42
-
43
-
```yaml
44
-
- source: project
45
-
posit-cloud:
46
-
- id: "1234"
47
-
url: "https://posit.cloud/content/1234"
48
-
```
49
-
50
-
Account information is not stored in this file, so it is suitable for checking in to version control and being shared by multiple publishers.
51
-
52
-
You can customize this behavior of `quarto publish` by providing the following command line options:
53
-
54
-
{{< include _cli-options.md >}}
55
-
56
-
To publish a document rather than a website or book, provide the path to the document:
57
-
58
-
```{.bash filename="Terminal"}
59
-
quarto publish posit-cloud document.qmd
60
-
```
61
-
62
-
## Publishing with Code
63
-
64
-
In the preceding example, we rendered content locally and then published it to Posit Cloud. In some cases, however, you may want to publish your source code to Posit Cloud and then have it rendered on the server.
65
-
66
-
The tools for publishing code differ depending on whether you are using the Knitr (R) or Jupyter (Python) engine, so we'll cover them separately below.
67
-
68
-
### Knitr (R)
69
-
70
-
The [rsconnect](https://rstudio.github.io/rsconnect/) R package includes a set of publishing functions that you can use for publishing Quarto projects with R code to Posit Cloud.
71
-
72
-
Your credentials can be found in Posit Cloud under Account > Tokens. To add your credentials, use:
Once your credentials have been added, you can publish your project. Here we publish a document and a website:
85
-
86
-
``` r
87
-
library(rsconnect)
88
-
89
-
deployDoc("document.qmd")
90
-
deployApp("./my-site")
91
-
```
92
-
93
-
#### RStudio IDE
94
-
95
-
If you are using the RStudio IDE, there is also support for push-button publishing to Posit Cloud. Use the publish button <kbd>{width="23" height="20"}</kbd> from the source editor or viewer pane to publish a document or a website.
96
-
97
-
See the Posit Cloud documentation on [Publishing](https://posit.cloud/learn/guide#publish) for additional details.
98
-
99
-
### Jupyter (Python)
100
-
101
-
The [rsconnect-python](https://docs.posit.co/rsconnect-python/) Python package provides a command line interface (CLI) that you can use to publish Quarto documents and websites that use Jupyter to Posit Cloud. To use the CLI:
102
-
103
-
1. First, install the rsconnect-python package and configure a Posit Cloud credential for publishing (values available under Account > Tokens):
2. Then, use the `rsconnect deploy quarto` command from your project directory:
115
-
116
-
```{.bash filename="Terminal"}
117
-
rsconnect deploy quarto
118
-
```
119
-
120
-
See the complete documentation on [Publishing Quarto Content](https://docs.posit.co/connect/user/publishing-cli-quarto/) for additional details on using the CLI for publishing.
121
-
122
-
## Continuous Integration
123
-
124
-
You can also deploy Quarto content using a Continuous Integration (CI) service like [Jenkins](https://www.jenkins.io/), [Airflow](https://airflow.apache.org/), or [GitHub Actions](https://docs.github.com/en/actions). In most cases, this will entail scripting the `quarto publish` command, however in the case of GitHub Actions, you can take advantage of the standard Quarto [publish action](https://github.com/quarto-dev/quarto-actions/tree/main/publish).
125
-
126
-
When publishing to Posit Cloud from a CI service you'll need to consider whether you want to execute your Python or R code directly on the CI server or whether you want to take advantage of previously [frozen](/docs/projects/code-execution.html#freeze) execution results. We'll explore this possibility first and then proceed to the specifics of how to publish from CI.
127
-
128
-
### Freezing Computations
129
-
130
-
Depending on how complicated your run-time requirements (packages, database credentials, etc.) are, you might find it more convenient to restrict execution of Python and R code to local contexts that have the required software and credentials.
131
-
132
-
{{< include _freeze-basics.md >}}
133
-
134
-
If you'd rather have CI publishing execute all Python and R code contained in your project, you'll need to ensure that the requisite version of these tools (and any required packages) are installed on the CI server. How to do this is outside the scope of this article---to learn more about saving and restoring dependencies, see the article on [Virtual Environments](/docs/projects/virtual-environments.qmd).
135
-
136
-
### Publish Command
137
-
138
-
You can publish Quarto content to Posit Cloud using any CI service by scripting the `quarto publish` command. To do this, you'll need to make sure that your credentials are available as environment variables on the CI server.
| `POSIT_CLOUD_TOKEN` | A user's authentication token. |
143
-
| `POSIT_CLOUD_SECRET` | The secret associated with the token. |
144
-
145
-
You will furthermore need to specify the ID of the target content to update. This will most frequently be drawn from the `_publish.yml` file that is saved into your project directory during publishing. For example:
146
-
147
-
```{.yaml filename="_publish.yml"}
148
-
- source: project
149
-
posit-cloud:
150
-
- id: 1234
151
-
url: 'https://posit.cloud/content/1234/'
152
-
```
153
-
154
-
Assuming that you have a `_publish.yml` like the above, you can publish to Posit Cloud from CI with the following commands:
Alternatively, if you don't have a `_publish.yml` file, you can specify the ID on the command line as follows:
163
-
164
-
```{.bash filename="Terminal"}
165
-
quarto publish posit-cloud --id 1234
166
-
```
167
-
168
-
### GitHub Actions
169
-
170
-
If your CI service is [GitHub Actions](https://docs.github.com/en/actions) then you can take advantage of Quarto's standard [publish action](https://github.com/quarto-dev/quarto-actions/tree/main/publish) to automate deploying to Posit Cloud.
171
-
172
-
#### User Credentials
173
-
174
-
Before creating the publish action, you need to ensure that your repository has the credentials required for publishing to Posit Cloud. You can do this as follows:
175
-
176
-
1. If you don't already have one, create a token and token secret in Posit Cloud (under Account > Tokens).
177
-
178
-
2. Add the token secret to your repository's action **Secrets** (accessible within repository **Settings**). Under **Repository Secrets**, you'll see a **New repository secret** button:
179
-
180
-
{.border fig-alt="Screenshot of a GitHub repository's Secrets and Variables page for Actions."}
181
-
182
-
Click the button and add the API Key from step 1 as a secret named `POSIT_CLOUD_SECRET`:
183
-
184
-
{.border fig-alt="Screenshot of a GitHub repository's page for adding a new Actions secret."}
185
-
186
-
#### Publish Action
187
-
188
-
To setup your publish action, create a `.github/workflows/publish.yml` file in your repository. If you are [Freezing Computations] (i.e. not running Python or R code within your action), then the file would look something like this:
Once you've pushed your updated repository (including the publish action and `_freeze` directory) to GitHub, your action will run with this and subsequent commits, automatically rendering and publishing to Posit Cloud.
217
-
218
-
#### Executing Code
219
-
220
-
If you prefer, you can also configure GitHub Actions to execute Python or R code as part of rendering. While this might reflexively seem like the best approach, consider the following requirements imposed when you execute code within a CI service like GitHub Actions:
221
-
222
-
{{< include _ci-execute-requirements.md >}}
223
-
224
-
##### Prerequisites
225
-
226
-
The best way to ensure that your code can be executed within a GitHub Action is to use a virtual environment like [venv](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment) or [renv](https://rstudio.github.io/renv/articles/renv.html) with your project (below we'll provide example actions for each). If you aren't familiar with using these tools check out the article on using [Virtual Environments](/docs/projects/virtual-environments.qmd) with Quarto to learn more.
227
-
228
-
Once you've decided to execute code within your GitHub Action you can remove the `freeze: auto` described above from your `_quarto.yml` configuration. Note that if you want to use `freeze` selectively for some documents or directories that is still possible (for a directory, create a `_metadata.yml` file in the directory and specify your freeze configuration there---this is what Quarto does by default for the `posts` folder of blog projects).
229
-
230
-
##### Example: Jupyter with venv
231
-
232
-
Here is a complete example of a GitHub Action that installs Python, Jupyter, and package dependencies from `requirements.txt`, then executes code and renders output to Posit Cloud:
Here is a complete example of a GitHub Action that installs R and package dependencies from `renv.lock`, then executes code and renders output to Posit Cloud:
It's possible to have a Quarto project in a larger GitHub repository, where the Quarto project does not reside at the top-level directory. In this case, add a `path` input to the invocation of the `publish` action. For example:
By default, `quarto publish` will re-render your project before publishing it. However, if you store the rendered output in version control, you don't need the GitHub action to re-render the project. In that case, add the option `render: false` to the `publish` action:
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments