From 2e6378c1b598ff3def88b159a3190f800bf511dc Mon Sep 17 00:00:00 2001 From: "Benjamin R. J. Schwedler" Date: Wed, 28 Jan 2026 15:55:54 -0600 Subject: [PATCH 1/2] Update documentation for Posit style Applies suggestions from the `doc-reviewer` skill. --- CONTRIBUTING.md | 6 +++--- README.md | 9 +++------ charts/rstudio-connect/README.md | 2 +- docs/customize.md | 4 +++- examples/connect/auth/oidc.qmd | 4 ++-- examples/connect/auth/saml.qmd | 4 ++-- examples/connect/container-images/custom-images.qmd | 6 +++--- examples/connect/ingress/aws-alb.qmd | 2 +- examples/connect/ingress/azure-gateway.qmd | 2 +- examples/connect/ingress/gce.qmd | 2 +- examples/connect/ingress/nginx.qmd | 4 ++-- examples/connect/ingress/traefik.qmd | 2 +- examples/package-manager/ingress/aws-alb.qmd | 2 +- examples/package-manager/ingress/azure-gateway.qmd | 4 ++-- examples/package-manager/ingress/gce.qmd | 2 +- examples/package-manager/ingress/nginx.qmd | 2 +- examples/workbench/auth-user-provisioning/oidc.qmd | 4 ++-- examples/workbench/auth-user-provisioning/saml.qmd | 4 ++-- examples/workbench/index.qmd | 2 +- examples/workbench/ingress/aws-alb.qmd | 2 +- examples/workbench/ingress/azure-gateway.qmd | 2 +- examples/workbench/ingress/gce.qmd | 2 +- examples/workbench/ingress/nginx.qmd | 4 ++-- examples/workbench/ingress/traefik.qmd | 2 +- 24 files changed, 39 insertions(+), 40 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 929a8494b..1f014cb4d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,9 +97,9 @@ flowchart TB; id3-- "copy as-is" -->id4 ``` -> **IMPORTANT NOTE**: The template version is _tied to the product version_, and may differ between -> products. Take care when updating a product's template versions, and ensure that you have tested -> with a proper license to ensure that the product is functional. +:::{.callout-important} +The template version is tied to the product version, and may differ between products. Take care when updating a product's template versions, and ensure that you have tested with a proper license to ensure that the product is functional. +::: At some point, we plan to push some (all?) of the `helm`-based features upstream into the original. However, for now we are evaluating and gathering feedback on the mechanism. In particular, we need to explore what "sub-templating" and diff --git a/README.md b/README.md index 539dd0cf6..1c00eef09 100644 --- a/README.md +++ b/README.md @@ -44,12 +44,9 @@ Supporting and miscellaneous charts with varying levels of maintenance, usefulne ## Support -**IMPORTANT:** - -These charts are provided as a convenience to Posit customers. If you have -questions about these charts, you can ask them in the -[issues](https://github.com/rstudio/helm/issues/new/choose) in the repository -or to your support representative, who will route them appropriately. +:::{.callout-important} +These charts are provided as a convenience to Posit customers. If you have questions about these charts, you can ask them in the [issues](https://github.com/rstudio/helm/issues/new/choose) in the repository or to your support representative, who will route them appropriately. +::: Bugs or feature requests should be opened in an [issue](https://github.com/rstudio/helm/issues/new/choose). diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 80954bff5..20a7a25a6 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -22,7 +22,7 @@ To ensure reproducibility in your environment and insulate yourself from future * the `--version` flag. :::{.callout-important} - This protects you from breaking changes** + This protects you from breaking changes. ::: * Before upgrading check for breaking changes using `helm-diff` plugin and `helm diff upgrade`. diff --git a/docs/customize.md b/docs/customize.md index 1453cc68b..c4d573de8 100644 --- a/docs/customize.md +++ b/docs/customize.md @@ -29,7 +29,9 @@ The `rstudio-library` chart will ensure that: - the array is aggregated into the required comma-separated list - the `target` part of the job spec will be modified by the Job Launcher -**IMPORTANT:** `name` is arbitrary, but must be unique! (And should contain no spaces) +:::{.callout-important} +`name` is arbitrary, but must be unique (and should contain no spaces). +::: See examples below. diff --git a/examples/connect/auth/oidc.qmd b/examples/connect/auth/oidc.qmd index 0ec27f091..06e574db0 100644 --- a/examples/connect/auth/oidc.qmd +++ b/examples/connect/auth/oidc.qmd @@ -4,9 +4,9 @@ category: "Authentication" # Configuring Posit Connect with OpenID Connect -This example deploys Posit Connect using OpenID Connect (OIDC) SSO for authentication. +This example deploys Posit Connect using OpenID Connect (OIDC) Single Sign-On (SSO) for authentication. -Users will be authenticated via SSO (using OIDC) and then users will be created in Connect upon first login or upon creation via the Connect API. Connect will populate user information based on certain claims received from the IdP. See the [Customizing OpenID Connect](https://docs.posit.co/connect/admin/authentication/oauth2-openid-based/openid-connect/#customizing-openid-connect) section of the Connect Admin Guide for a list of the default claims mapping, which can be adjusted if needed. +Users authenticate via SSO (using OIDC) and Connect creates user accounts upon first login or upon creation via the Connect API. Connect will populate user information based on certain claims received from the IdP. See the [Customizing OpenID Connect](https://docs.posit.co/connect/admin/authentication/oauth2-openid-based/openid-connect/#customizing-openid-connect) section of the Connect Admin Guide for a list of the default claims mapping, which can be adjusted if needed. By default all users get created with the Viewer role which is the default setting in [`Authorization.DefaultUserRole`](https://docs.posit.co/connect/admin/appendix/configuration/#Authorization.DefaultUserRole). Users can be [automatically mapped to different roles](https://docs.posit.co/connect/admin/authentication/oauth2-openid-based/openid-connect/#user-role-mapping) based on group membership. diff --git a/examples/connect/auth/saml.qmd b/examples/connect/auth/saml.qmd index d112c5e28..a15e3fa9f 100644 --- a/examples/connect/auth/saml.qmd +++ b/examples/connect/auth/saml.qmd @@ -4,9 +4,9 @@ category: "Authentication" # Configuring Posit Connect with SAML -This example deploys Posit Connect using SAML SSO for authentication. +This example deploys Posit Connect using SAML Single Sign-On (SSO) for authentication. -Users will be authenticated via SSO (using SAML) and then users will be created in Connect upon first login or upon creation via the Connect API. Connect will populate user information based on certain attributes received from the IdP. `IdPAttributeProfile` may be set to prepopulate attribute mapping for common IdPs, set to `default` for a common generic mapping or left empty to manually map each attribute. See the [Using attribute profiles](https://docs.posit.co/connect/admin/authentication/saml-based/saml/#attribute-profiles) section of the Connect Admin Guide for more details regarding profile mappings. +Users authenticate via SSO (using SAML) and Connect creates user accounts upon first login or upon creation via the Connect API. Connect will populate user information based on certain attributes received from the IdP. `IdPAttributeProfile` may be set to prepopulate attribute mapping for common IdPs, set to `default` for a common generic mapping or left empty to manually map each attribute. See the [Using attribute profiles](https://docs.posit.co/connect/admin/authentication/saml-based/saml/#attribute-profiles) section of the Connect Admin Guide for more details regarding profile mappings. By default all users get created with the Viewer role which is the default setting in [`Authorization.DefaultUserRole`](https://docs.posit.co/connect/admin/appendix/configuration/#Authorization.DefaultUserRole). Users can be [automatically mapped to different roles](https://docs.posit.co/connect/admin/authentication/saml-based/saml/#user-role-mapping) based on group membership. diff --git a/examples/connect/container-images/custom-images.qmd b/examples/connect/container-images/custom-images.qmd index 0b73badc1..bcf6eb896 100644 --- a/examples/connect/container-images/custom-images.qmd +++ b/examples/connect/container-images/custom-images.qmd @@ -6,13 +6,13 @@ category: "Container images" This example deploys Posit Connect using custom images instead of the default public Posit provided images. -There are a minimum of three images that Connect requires to function in Off-Host Execution mode. They are listed below with their cooresponding default public repositories. +Connect requires a minimum of three images to function in Off-Host Execution mode. The following list shows the default public repositories: - Connect service container [rstudio/rstudio-connect](https://hub.docker.com/r/rstudio/rstudio-connect) - Content container [rstudio/content-base](https://hub.docker.com/r/rstudio/content-base) - Content init container [rstudio/rstudio-connect-content-init](https://hub.docker.com/r/rstudio/rstudio-connect-content-init) - -There are several content contents listed as execution enviornments by default on initial Connect startup based on the listing in the [default-runtime.yaml](https://github.com/rstudio/helm/blob/main/charts/rstudio-connect/default-runtime.yaml) file. Setting `customRuntimeYaml` will instead use the execution environments defined in that section instead of the default ones. Additional content containers may be added to provide more R, Python and Quarto versions and other system dependencies. See the [Content Execution Environment](https://docs.posit.co/connect/admin/appendix/off-host/execution-environments/) section in the Connect Admin Guide for more details. + +Connect lists several content containers as execution environments by default on initial startup based on the [default-runtime.yaml](https://github.com/rstudio/helm/blob/main/charts/rstudio-connect/default-runtime.yaml) file. Setting `customRuntimeYaml` will instead use the execution environments defined in that section instead of the default ones. Additional content containers may be added to provide more R, Python and Quarto versions and other system dependencies. See the [Content Execution Environment](https://docs.posit.co/connect/admin/appendix/off-host/execution-environments/) section in the Connect Admin Guide for more details. {{< include ../_prereqs.qmd >}} diff --git a/examples/connect/ingress/aws-alb.qmd b/examples/connect/ingress/aws-alb.qmd index 7e226d32a..c5854a4ef 100644 --- a/examples/connect/ingress/aws-alb.qmd +++ b/examples/connect/ingress/aws-alb.qmd @@ -6,7 +6,7 @@ category: "Ingress" This example deploys Posit Connect with an Ingress using the AWS Load Balancer Controller to create an Application Load Balancer (ALB). -This example is provided to show how to set annotations to enabled session affinity, redirect HTTP traffic to HTTPS and use AWS Certificate Manager if desired. +This example shows how to set annotations to enable session affinity, redirect HTTP traffic to HTTPS, and use AWS Certificate Manager if desired. The AWS Load Balancer Controller has a variety of settings and modes of operation. Please visit the [AWS documentation](https://kubernetes-sigs.github.io/aws-load-balancer-controller/) for more details specific to your use case. diff --git a/examples/connect/ingress/azure-gateway.qmd b/examples/connect/ingress/azure-gateway.qmd index bd0e925d0..cb35ce7fa 100644 --- a/examples/connect/ingress/azure-gateway.qmd +++ b/examples/connect/ingress/azure-gateway.qmd @@ -5,7 +5,7 @@ category: "Ingress" # Configuring Posit Connect with an Azure Application Gateway Ingress This example deploys Posit Connect with an Ingress using the Azure Application Gateway Ingress Controller to create an Azure Application Gateway load balancer. -This example is provided to show how to set annotations to enabled session affinity and to redirect HTTP traffic to HTTPS. +This example shows how to set annotations to enable session affinity and to redirect HTTP traffic to HTTPS. The Azure Application Gateway Ingress Controller has a variety of settings and modes of operation. Please visit the [Azure documentation](https://azure.github.io/application-gateway-kubernetes-ingress/) for more details specific to your use case. diff --git a/examples/connect/ingress/gce.qmd b/examples/connect/ingress/gce.qmd index 0121ab296..ddf590812 100644 --- a/examples/connect/ingress/gce.qmd +++ b/examples/connect/ingress/gce.qmd @@ -5,7 +5,7 @@ category: "Ingress" # Configuring Posit Connect with a GKE Ingress This example deploys Posit Connect with an Ingress using the GKE Ingress Controller to create a GCP Application Load Balancer. -This example is provided to show how to set annotations to enabled session affinity, redirect HTTP traffic to HTTPS and use GCP Certificate Manager if desired. +This example shows how to set annotations to enable session affinity, redirect HTTP traffic to HTTPS, and use GCP Certificate Manager if desired. The GKE Ingress Controller has a variety of settings and modes of operation. Please visit the [GCP documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress) for more details specific to your use case. diff --git a/examples/connect/ingress/nginx.qmd b/examples/connect/ingress/nginx.qmd index beb051973..60e331b03 100644 --- a/examples/connect/ingress/nginx.qmd +++ b/examples/connect/ingress/nginx.qmd @@ -5,12 +5,12 @@ category: "Ingress" # Configuring Posit Connect with a NGINX Ingress This example deploys Posit Connect with an Ingress using the Ingress NGINX Controller. -This example is provided to show how to set annotations to enabled session affinity and to redirect HTTP traffic to HTTPS. +This example shows how to set annotations to enable session affinity and to redirect HTTP traffic to HTTPS. The Ingress NGINX Controller has a variety of settings and modes of operation. Please visit the [NGINX controller documentation](https://kubernetes.github.io/ingress-nginx/) for more details specific to your use case. -::: callout-note +:::{.callout-note} This example is for the Ingress NGINX Controller which is part of Kubernetes and is located at [https://github.com/kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx). If you are using the NGINX or NGINX Plus Ingress Controllers from NGINX Inc located at [https://github.com/nginxinc/kubernetes-ingress](https://github.com/nginxinc/kubernetes-ingress) then different annotations will need to be applied. ::: diff --git a/examples/connect/ingress/traefik.qmd b/examples/connect/ingress/traefik.qmd index 1e6b16654..a1deb1663 100644 --- a/examples/connect/ingress/traefik.qmd +++ b/examples/connect/ingress/traefik.qmd @@ -5,7 +5,7 @@ category: "Ingress" # Configuring Posit Connect with a Traefik Ingress This example deploys Posit Connect with an Ingress using the Traefik Ingress Controller. -This example is provided to show how to set annotations to enabled session affinity and to redirect HTTP traffic to HTTPS. +This example shows how to set annotations to enable session affinity and to redirect HTTP traffic to HTTPS. The Traefik Ingress Controller has a variety of settings and modes of operation. Please visit the [Traefik documentation](https://doc.traefik.io/traefik/providers/kubernetes-ingress/) for more details specific to your use case. diff --git a/examples/package-manager/ingress/aws-alb.qmd b/examples/package-manager/ingress/aws-alb.qmd index e8f8689f8..922ed44a1 100644 --- a/examples/package-manager/ingress/aws-alb.qmd +++ b/examples/package-manager/ingress/aws-alb.qmd @@ -5,7 +5,7 @@ category: "Ingress" # Configuring Posit Package Manager with an AWS ALB Ingress This example deploys Posit Package Manager with an Ingress using the AWS Load Balancer Controller to create an Application Load Balancer (ALB). -This example is provided to show how to set annotations to redirect HTTP traffic to HTTPS and use AWS Certificate Manager if desired. +This example shows how to set annotations to redirect HTTP traffic to HTTPS and use AWS Certificate Manager if desired. The AWS Load Balancer Controller has a variety of settings and modes of operation. Please visit the [AWS documentation](https://kubernetes-sigs.github.io/aws-load-balancer-controller/) for more details specific to your use case. diff --git a/examples/package-manager/ingress/azure-gateway.qmd b/examples/package-manager/ingress/azure-gateway.qmd index ad2f078cd..54dcea6c2 100644 --- a/examples/package-manager/ingress/azure-gateway.qmd +++ b/examples/package-manager/ingress/azure-gateway.qmd @@ -4,8 +4,8 @@ category: "Ingress" # Configuring Posit Package Manager with an Azure Application Gateway -This example deploys Posit Package Manager with an Ingress using the Azure Application Gateway Ingress Controller to create a Azure Application Gateway load balancer. -This example is provided to show how to set annotations to redirect HTTP traffic to HTTPS. +This example deploys Posit Package Manager with an Ingress using the Azure Application Gateway Ingress Controller to create an Azure Application Gateway load balancer. +This example shows how to set annotations to redirect HTTP traffic to HTTPS. The Azure Application Gateway Ingress Controller has a variety of settings and modes of operation. Please visit the [Azure documentation](https://azure.github.io/application-gateway-kubernetes-ingress/) for more details specific to your use case. diff --git a/examples/package-manager/ingress/gce.qmd b/examples/package-manager/ingress/gce.qmd index cc6c42ae1..dd96f5bb9 100644 --- a/examples/package-manager/ingress/gce.qmd +++ b/examples/package-manager/ingress/gce.qmd @@ -5,7 +5,7 @@ category: "Ingress" # Configuring Posit Package Manager with a GCE Ingress This example deploys Posit Package Manager with an Ingress using the GKE Ingress Controller to create a GCP Application Load Balancer. -This example is provided to show how to set annotations to redirect HTTP traffic to HTTPS and use GCP Certificate Manager if desired. +This example shows how to set annotations to redirect HTTP traffic to HTTPS and use GCP Certificate Manager if desired. The GKE Ingress Controller has a variety of settings and modes of operation. Please visit the [GCP documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress) for more details specific to your use case. diff --git a/examples/package-manager/ingress/nginx.qmd b/examples/package-manager/ingress/nginx.qmd index e1ae833e8..570f184e2 100644 --- a/examples/package-manager/ingress/nginx.qmd +++ b/examples/package-manager/ingress/nginx.qmd @@ -8,7 +8,7 @@ This example deploys Posit Package Manager with an Ingress using the Ingress NGI The Ingress NGINX Controller has a variety of settings and modes of operation. Please visit the [NGINX controller documentation](https://kubernetes.github.io/ingress-nginx/) for more details specific to your use case. -::: callout-note +:::{.callout-note} This example is for the Ingress NGINX Controller which is part of Kubernetes and is located at [https://github.com/kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx). If you are using the NGINX or NGINX Plus Ingress Controllers from NGINX Inc located at [https://github.com/nginxinc/kubernetes-ingress](https://github.com/nginxinc/kubernetes-ingress) then different annotations will need to be applied. ::: diff --git a/examples/workbench/auth-user-provisioning/oidc.qmd b/examples/workbench/auth-user-provisioning/oidc.qmd index 09da06a5c..7b5bcbab8 100644 --- a/examples/workbench/auth-user-provisioning/oidc.qmd +++ b/examples/workbench/auth-user-provisioning/oidc.qmd @@ -4,9 +4,9 @@ category: Authentication # Configuring Posit Workbench with OpenID Connect -This example deploys Posit Workbench using OpenID Connect (OIDC) SSO for authentication and `sssd` for user provisioning. +This example deploys Posit Workbench using OpenID Connect (OIDC) Single Sign-On (SSO) for authentication and `sssd` for user provisioning. -Users will be authenticated via SSO (using OIDC) and Workbench will match a claim (`preferred_username` by default) to a Linux user account in the Workbench container. +Users authenticate via SSO (using OIDC) and Workbench matches a claim (`preferred_username` by default) to a Linux user account in the Workbench container. `sssd` is already running in the Workbench container and can be used to automatically provision local user accounts using LDAP or Active Directory. See the [OpenID Connect Authentication](https://docs.posit.co/ide/server-pro/authenticating_users/openid_connect_authentication.html) section of the Workbench Admin Guide for more details. diff --git a/examples/workbench/auth-user-provisioning/saml.qmd b/examples/workbench/auth-user-provisioning/saml.qmd index 75ad3cbc9..cf046da6a 100644 --- a/examples/workbench/auth-user-provisioning/saml.qmd +++ b/examples/workbench/auth-user-provisioning/saml.qmd @@ -4,9 +4,9 @@ category: Authentication # Configuring Posit Workbench with SAML -This example deploys Posit Workbench using SAML SSO for authentication and `sssd` for user provisioning. +This example deploys Posit Workbench using SAML Single Sign-On (SSO) for authentication and `sssd` for user provisioning. -Users will be authenticated via SSO (using SAML) and Workbench will match an attribute (`Username` by default) to a Linux user account in the Workbench container. +Users authenticate via SSO (using SAML) and Workbench matches an attribute (`Username` by default) to a Linux user account in the Workbench container. `sssd` is already running in the Workbench container and can be used to automatically provision local user accounts using LDAP or Active Directory. See the [SAML Single Sign-On Authentication](https://docs.posit.co/ide/server-pro/authenticating_users/saml_sso.html) section of the Workbench Admin Guide for more details. diff --git a/examples/workbench/index.qmd b/examples/workbench/index.qmd index 2a3fb88af..e8002d6f0 100644 --- a/examples/workbench/index.qmd +++ b/examples/workbench/index.qmd @@ -10,7 +10,7 @@ Each example has a beginning description and a series of `TODO` comments. Before using an example, read through all the comments and ensure you address each `TODO`. -While each example focuses on one or more particular configurations, RStudio Workbench has some standard requirements listed in each example. +While each example focuses on one or more particular configurations, Posit Workbench has some standard requirements listed in each example. Each example needs the following to run correctly: diff --git a/examples/workbench/ingress/aws-alb.qmd b/examples/workbench/ingress/aws-alb.qmd index 8c2810e47..345864186 100644 --- a/examples/workbench/ingress/aws-alb.qmd +++ b/examples/workbench/ingress/aws-alb.qmd @@ -5,7 +5,7 @@ category: "Ingress" # Configuring Posit Workbench with an AWS ALB Ingress This example deploys Posit Workbench with an Ingress using the AWS Load Balancer Controller to create an Application Load Balancer (ALB). -This example is provided to show how to set annotations to enable session affinity, redirect HTTP traffic to HTTPS and use AWS Certificate Manager if desired. +This example shows how to set annotations to enable session affinity, redirect HTTP traffic to HTTPS, and use AWS Certificate Manager if desired. The AWS Load Balancer Controller has a variety of settings and modes of operation. Please visit the [AWS documentation](https://kubernetes-sigs.github.io/aws-load-balancer-controller/) for more details specific to your use case. diff --git a/examples/workbench/ingress/azure-gateway.qmd b/examples/workbench/ingress/azure-gateway.qmd index ca0947507..55c756746 100644 --- a/examples/workbench/ingress/azure-gateway.qmd +++ b/examples/workbench/ingress/azure-gateway.qmd @@ -5,7 +5,7 @@ category: "Ingress" # Configuring Posit Workbench with an Azure Application Gateway Ingress This example deploys Posit Workbench with an Ingress using the Azure Application Gateway Ingress Controller to create an Azure Application Gateway load balancer. -This example is provided to show how to set annotations to enabled session affinity and to redirect HTTP traffic to HTTPS. +This example shows how to set annotations to enable session affinity and to redirect HTTP traffic to HTTPS. The Azure Application Gateway Ingress Controller has a variety of settings and modes of operation. Please visit the [Azure documentation](https://azure.github.io/application-gateway-kubernetes-ingress/) for more details specific to your use case. diff --git a/examples/workbench/ingress/gce.qmd b/examples/workbench/ingress/gce.qmd index e026b567e..66d5719bf 100644 --- a/examples/workbench/ingress/gce.qmd +++ b/examples/workbench/ingress/gce.qmd @@ -5,7 +5,7 @@ category: "Ingress" # Configuring Posit Workbench with a GKE Ingress This example deploys Posit Workbench with an Ingress using the GKE Ingress Controller to create a GCP Application Load Balancer. -This example is provided to show how to set annotations to enabled session affinity, redirect HTTP traffic to HTTPS and use GCP Certificate Manager if desired. +This example shows how to set annotations to enable session affinity, redirect HTTP traffic to HTTPS, and use GCP Certificate Manager if desired. The GKE Ingress Controller has a variety of settings and modes of operation. Please visit the [GCP documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress) for more details specific to your use case. diff --git a/examples/workbench/ingress/nginx.qmd b/examples/workbench/ingress/nginx.qmd index 366629f3d..fad52d254 100644 --- a/examples/workbench/ingress/nginx.qmd +++ b/examples/workbench/ingress/nginx.qmd @@ -5,11 +5,11 @@ category: "Ingress" # Configuring Posit Workbench with a NGINX Ingress This example deploys Posit Workbench with an Ingress using the Ingress NGINX Controller. -This example is provided to show how to set annotations to enabled session affinity and to redirect HTTP traffic to HTTPS. +This example shows how to set annotations to enable session affinity and to redirect HTTP traffic to HTTPS. The Ingress NGINX Controller has a variety of settings and modes of operation. Please visit the [NGINX controller documentation](https://kubernetes.github.io/ingress-nginx/) for more details specific to your use case. -::: callout-note +:::{.callout-note} This example is for the Ingress NGINX Controller which is part of Kubernetes and is located at [https://github.com/kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx). If you are using the NGINX or NGINX Plus Ingress Controllers from NGINX Inc located at [https://github.com/nginxinc/kubernetes-ingress](https://github.com/nginxinc/kubernetes-ingress) then different annotations will need to be applied. ::: diff --git a/examples/workbench/ingress/traefik.qmd b/examples/workbench/ingress/traefik.qmd index 1af05670b..47df0a643 100644 --- a/examples/workbench/ingress/traefik.qmd +++ b/examples/workbench/ingress/traefik.qmd @@ -5,7 +5,7 @@ category: "Ingress" # Configuring Posit Workbench with a Traefik Ingress This example deploys Posit Workbench with an Ingress using the Traefik Ingress Controller. -This example is provided to show how to set annotations to enabled session affinity and to redirect HTTP traffic to HTTPS. +This example shows how to set annotations to enable session affinity and to redirect HTTP traffic to HTTPS. The Traefik Ingress Controller has a variety of settings and modes of operation. Please visit the [Traefik documentation](https://doc.traefik.io/traefik/providers/kubernetes-ingress/) for more details specific to your use case. From d7833d03cc4ccaf635dfde8fb5b6d0066f6d1cf5 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 28 Jan 2026 21:57:44 +0000 Subject: [PATCH 2/2] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 20a7a25a6..80954bff5 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -22,7 +22,7 @@ To ensure reproducibility in your environment and insulate yourself from future * the `--version` flag. :::{.callout-important} - This protects you from breaking changes. + This protects you from breaking changes** ::: * Before upgrading check for breaking changes using `helm-diff` plugin and `helm diff upgrade`.