From d2b8c575b919a5e7759a62daedc9a1bf9e0a1628 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Fri, 4 Oct 2024 13:44:14 -0700 Subject: [PATCH 01/14] Work in progress improved extension README --- extensions/vscode/README.md | 59 +++++++++++++++++++++++++++++++++---- 1 file changed, 54 insertions(+), 5 deletions(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 11855a173..74d8548dd 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -1,11 +1,60 @@ -# Posit Publisher +# Posit Publisher - Deploy to Posit Connect -[Posit Publisher](https://github.com/posit-dev/publisher) is an extension for -[Visual Studio Code](https://code.visualstudio.com/) that provides an easy -way to deploy to [Posit Connect](https://posit.co/products/enterprise/connect/). +[Posit Publisher](https://github.com/posit-dev/publisher) is a code-first tool +for deploying to +[Posit Connect](https://posit.co/products/enterprise/connect/). ## Installation -Install Posit Publisher from the +Install Posit Publisher by using the Install button above, or using the +Extensions side bar in [Positron](https://github.com/posit-dev/positron) or +[VS Code](https://code.visualstudio.com/) and searching for `posit.publisher`. + +Posit Publisher is available from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Posit.publisher) or from the [Open VSX Registry](https://open-vsx.org/extension/posit/publisher). + +## Features + +### Code-First Deployment + +Configure your project and then deploy your content to Posit Connect with a +click. + +[Configuration files](https://github.com/posit-dev/publisher/blob/main/docs/configuration.md) +allow setting up how you want your content to look and run on Connect - from +choosing a title and description to +[Runtime process settings](https://docs.posit.co/connect/user/content-settings/#content-runtime). + +Keep your content stable with language and tool versions set in your +configurations- all automatically detected based on your local environment. + +Everything is saved under `.posit/` in your project directory for easy +re-deployment and collaboration. + +### Seamless Collaboration + +Share your deployments and configurations with your team by committing the +`.posit/` directory to your version control system, allowing Collaborators to +easily pick up where you left off. + +### Track all Deployments for a Project + +Separate staging and production deployments easily per project. + +### Deployment Logs + +Logs are organized to easily identify what went wrong. + +Deploying Logs with organized steps in the Posit Publisher Logs view + +## Help and Feedback + +Documentation can be found in the +[open source repository](https://github.com/posit-dev/publisher/blob/main/docs/index.md). + +Report bugs or request features using +[GitHub Issues](https://github.com/posit-dev/publisher/issues). From bf61779f807d539d533688a3ebfb10acb8650d9b Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Tue, 8 Oct 2024 12:36:29 -0700 Subject: [PATCH 02/14] Adjust VS Code readme to match Posit style guide --- extensions/vscode/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 74d8548dd..7323fd77b 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -6,8 +6,8 @@ for deploying to ## Installation -Install Posit Publisher by using the Install button above, or using the -Extensions side bar in [Positron](https://github.com/posit-dev/positron) or +Install Posit Publisher by using the **Install** button above, or using the +**Extensions** side bar in [Positron](https://github.com/posit-dev/positron) or [VS Code](https://code.visualstudio.com/) and searching for `posit.publisher`. Posit Publisher is available from the @@ -16,7 +16,7 @@ or from the [Open VSX Registry](https://open-vsx.org/extension/posit/publisher). ## Features -### Code-First Deployment +### Code-first deployment Configure your project and then deploy your content to Posit Connect with a click. @@ -32,17 +32,17 @@ configurations- all automatically detected based on your local environment. Everything is saved under `.posit/` in your project directory for easy re-deployment and collaboration. -### Seamless Collaboration +### Seamless collaboration Share your deployments and configurations with your team by committing the `.posit/` directory to your version control system, allowing Collaborators to easily pick up where you left off. -### Track all Deployments for a Project +### Track all deployments for a project Separate staging and production deployments easily per project. -### Deployment Logs +### Deployment logs Logs are organized to easily identify what went wrong. @@ -51,7 +51,7 @@ Logs are organized to easily identify what went wrong. alt="Deploying Logs with organized steps in the Posit Publisher Logs view" /> -## Help and Feedback +## Help and feedback Documentation can be found in the [open source repository](https://github.com/posit-dev/publisher/blob/main/docs/index.md). From 74a4450c8435796809ef6bc744f41221d4302c07 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Tue, 8 Oct 2024 16:06:35 -0700 Subject: [PATCH 03/14] Include supported content list in VS Code readme --- extensions/vscode/README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 7323fd77b..18f045e05 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -1,8 +1,15 @@ # Posit Publisher - Deploy to Posit Connect [Posit Publisher](https://github.com/posit-dev/publisher) is a code-first tool -for deploying to -[Posit Connect](https://posit.co/products/enterprise/connect/). +with a push-button user interface for deploying the things you build in R and +Python to [Posit Connect](https://posit.co/products/enterprise/connect/). + +Supported content includes: + +- Python content: APIs, applications, and notebooks +- Quarto content: `.qmd` and `.Rmd` files. Support for embedded Shiny apps +- R content: Shiny apps, RMarkdown, Plumber APIs, and Rmd with embedded + Shiny apps ## Installation From 1ab5d5566515684f0ff2e009536ce750f0a637bd Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Tue, 8 Oct 2024 16:06:51 -0700 Subject: [PATCH 04/14] Use the words content and project more carefully --- extensions/vscode/README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 18f045e05..1e5a19d0f 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -25,8 +25,7 @@ or from the [Open VSX Registry](https://open-vsx.org/extension/posit/publisher). ### Code-first deployment -Configure your project and then deploy your content to Posit Connect with a -click. +Configure your content and then deploy to Posit Connect with a click. [Configuration files](https://github.com/posit-dev/publisher/blob/main/docs/configuration.md) allow setting up how you want your content to look and run on Connect - from @@ -34,20 +33,22 @@ choosing a title and description to [Runtime process settings](https://docs.posit.co/connect/user/content-settings/#content-runtime). Keep your content stable with language and tool versions set in your -configurations- all automatically detected based on your local environment. +configurations — all automatically detected based on your local environment. -Everything is saved under `.posit/` in your project directory for easy -re-deployment and collaboration. +Everything is saved in the `.posit/` directory for easy re-deployment and +collaboration. ### Seamless collaboration -Share your deployments and configurations with your team by committing the -`.posit/` directory to your version control system, allowing Collaborators to -easily pick up where you left off. +Allow Collaborators to easily pick up where you left off by committing the +`.posit/` directory to your version control system. Your team can deploy using +the same deployments and configurations. ### Track all deployments for a project -Separate staging and production deployments easily per project. +Easily track all deployments for a project with Posit Publisher. + +For example, create separate deployments for staging and production. ### Deployment logs From 263e033d453bac701a8e309d7418323dd1fcc2b0 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Wed, 9 Oct 2024 11:28:32 -0700 Subject: [PATCH 05/14] Improve VS Code README wording --- extensions/vscode/README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 1e5a19d0f..5beaedc94 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -1,19 +1,19 @@ # Posit Publisher - Deploy to Posit Connect [Posit Publisher](https://github.com/posit-dev/publisher) is a code-first tool -with a push-button user interface for deploying the things you build in R and -Python to [Posit Connect](https://posit.co/products/enterprise/connect/). +with a push-button user interface for deploying the things you build in Python +and R to [Posit Connect](https://posit.co/products/enterprise/connect/). -Supported content includes: +Supported frameworks or content type include: - Python content: APIs, applications, and notebooks -- Quarto content: `.qmd` and `.Rmd` files. Support for embedded Shiny apps - R content: Shiny apps, RMarkdown, Plumber APIs, and Rmd with embedded Shiny apps +- Quarto content: `.qmd` and `.Rmd` files. Support for embedded Shiny apps ## Installation -Install Posit Publisher by using the **Install** button above, or using the +Install Posit Publisher using the **Install** button above, or using the **Extensions** side bar in [Positron](https://github.com/posit-dev/positron) or [VS Code](https://code.visualstudio.com/) and searching for `posit.publisher`. @@ -25,17 +25,22 @@ or from the [Open VSX Registry](https://open-vsx.org/extension/posit/publisher). ### Code-first deployment -Configure your content and then deploy to Posit Connect with a click. +Configure your content and then deploy to Posit Connect with ease. [Configuration files](https://github.com/posit-dev/publisher/blob/main/docs/configuration.md) -allow setting up how you want your content to look and run on Connect - from +allow setting up how you want your content to look and run on Connect — from choosing a title and description to [Runtime process settings](https://docs.posit.co/connect/user/content-settings/#content-runtime). Keep your content stable with language and tool versions set in your configurations — all automatically detected based on your local environment. -Everything is saved in the `.posit/` directory for easy re-deployment and +Keep your content stable with language and tool versions set in your +configurations — all automatically detected based on your local environment. +And you also have the control to pin them to the exact version that works for +you. + +Everything is saved in the `.posit/` directory for easy reproducibility and collaboration. ### Seamless collaboration From c269b9ded6e3e90a03b1749e3652aa2e38929863 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Wed, 9 Oct 2024 13:53:14 -0700 Subject: [PATCH 06/14] Remove seamless collaboration section from README --- extensions/vscode/README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 5beaedc94..9d5e8c68b 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -43,12 +43,6 @@ you. Everything is saved in the `.posit/` directory for easy reproducibility and collaboration. -### Seamless collaboration - -Allow Collaborators to easily pick up where you left off by committing the -`.posit/` directory to your version control system. Your team can deploy using -the same deployments and configurations. - ### Track all deployments for a project Easily track all deployments for a project with Posit Publisher. From b7827fded740e1fb2ed3b555d9ddc6351b47aafb Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Wed, 9 Oct 2024 13:53:41 -0700 Subject: [PATCH 07/14] Add associate feature section to VS Code README --- extensions/vscode/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 9d5e8c68b..6a0701674 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -49,6 +49,16 @@ Easily track all deployments for a project with Posit Publisher. For example, create separate deployments for staging and production. +### Associate already deployed content + +Posit Publisher isn't only for deploying something new. To start managing your +previously-deployed content in VS Code or Positron, associate your deployment +using just the content's URL. + +See the +[Updating Previously Deployed Content](https://github.com/posit-dev/publisher/blob/main/docs/vscode.md#updating-previously-deployed-content) +documentation for more information. + ### Deployment logs Logs are organized to easily identify what went wrong. From ee800be6e6413d8ef3ad79b7a0e06addeceaa773 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Wed, 9 Oct 2024 15:12:37 -0700 Subject: [PATCH 08/14] Add multiple deployments feature section to README --- extensions/vscode/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 6a0701674..297abdc30 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -59,6 +59,14 @@ See the [Updating Previously Deployed Content](https://github.com/posit-dev/publisher/blob/main/docs/vscode.md#updating-previously-deployed-content) documentation for more information. +### Multiple deployments and configurations + +Does your content need to be deployed to multiple destinations with different +settings? For example, to a staging environment and production. + +Posit Publisher supports managing multiple deployments and configurations, +simplifying the process of deploying to different environments. + ### Deployment logs Logs are organized to easily identify what went wrong. From fc7daad34c26ddb7eed668e5b3ceb44a529bfa3f Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Wed, 9 Oct 2024 15:45:48 -0700 Subject: [PATCH 09/14] Make track all content README section more clear --- extensions/vscode/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 297abdc30..25e0f9d6a 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -43,11 +43,11 @@ you. Everything is saved in the `.posit/` directory for easy reproducibility and collaboration. -### Track all deployments for a project +### Track all content for a project -Easily track all deployments for a project with Posit Publisher. - -For example, create separate deployments for staging and production. +If your project requires multiple pieces of content, Posit Publisher can manage +them all inside VS Code or Positron. For example, deploy an API and an +application to utilize it. ### Associate already deployed content From f5be95403c8eb4d1d4acc4c7d4f16e623aafd95f Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Wed, 9 Oct 2024 15:55:11 -0700 Subject: [PATCH 10/14] Add start in IDE and end in Connect section --- extensions/vscode/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 25e0f9d6a..46a1255e5 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -23,9 +23,17 @@ or from the [Open VSX Registry](https://open-vsx.org/extension/posit/publisher). ## Features +### Start in VS Code or Positron and end with content on Posit Connect + +Posit Publisher extends VS Code and Positron so you can stay in your development +environment to configure and deploy your content. Select the file you want +to deploy, and Posit Publisher will get you started with a configuration. + +Once you are ready, deploy your content to Posit Connect. + ### Code-first deployment -Configure your content and then deploy to Posit Connect with ease. +Configure your content with ease. [Configuration files](https://github.com/posit-dev/publisher/blob/main/docs/configuration.md) allow setting up how you want your content to look and run on Connect — from From 009ca04933d6cab47f3b94630548df40c2c41753 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Thu, 10 Oct 2024 11:11:08 -0700 Subject: [PATCH 11/14] Adjust wording in track all content README section --- extensions/vscode/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 46a1255e5..a2212065d 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -55,7 +55,7 @@ collaboration. If your project requires multiple pieces of content, Posit Publisher can manage them all inside VS Code or Positron. For example, deploy an API and an -application to utilize it. +application that utilizes it. ### Associate already deployed content From c47f255f657915332dfe541d8a0e9d4718dba1f9 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Fri, 11 Oct 2024 12:39:00 -0700 Subject: [PATCH 12/14] Remove images from README --- extensions/vscode/README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index a2212065d..219c26010 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -79,11 +79,6 @@ simplifying the process of deploying to different environments. Logs are organized to easily identify what went wrong. -Deploying Logs with organized steps in the Posit Publisher Logs view - ## Help and feedback Documentation can be found in the From 0ac3866a9d95c48dab5c206878041a3bac6fcab0 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Fri, 11 Oct 2024 12:43:00 -0700 Subject: [PATCH 13/14] Add deployment logs gif to README --- extensions/vscode/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 219c26010..9336586c1 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -79,6 +79,8 @@ simplifying the process of deploying to different environments. Logs are organized to easily identify what went wrong. +![Deploying logs with organized steps in the Posit Publisher Logs view](https://cdn.posit.co/publisher/assets/img/deployment-logs.gif) + ## Help and feedback Documentation can be found in the From 541a218f5e8e729ecbe3c603d7e03ed6935854e5 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Fri, 11 Oct 2024 12:44:10 -0700 Subject: [PATCH 14/14] Add VS Code to Connect gif to README --- extensions/vscode/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 9336586c1..8aba5145f 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -31,6 +31,8 @@ to deploy, and Posit Publisher will get you started with a configuration. Once you are ready, deploy your content to Posit Connect. +![Deploying content to Posit Connect using the Posit Publisher extension in VS Code](https://cdn.posit.co/publisher/assets/img/vscode-to-connect.gif) + ### Code-first deployment Configure your content with ease.