Skip to content

Posit Connect Documentation Consolidation#

Published: 06/01/2023

In an ongoing effort to improve the user experience with our documentation, beginning in version 2023.06.0, Posit Connect has consolidated several individual product guides into a single site!

Previously, each one of Connect's product guides was hosted on an individual site.

Now, the following Connect documentation is consolidated into a single site:

  • Admin Guide
  • User Guide
  • Server API Cookbook
  • API Reference
  • Release Notes

What does this mean?#

This dramatically improves our users' ability to search and discover content. Before the consolidation, if you searched a term within the Release Notes site, you would only get results for that individual site. Now, running a search crawls all of the content that we consolidated.

Since this is an ongoing effort, we have not consolidated all of our documentation content. Installation, upgrade, configuration, and integration content still lives at docs.posit.co and searching from the Admin Guide does not crawl content hosted at docs.posit.co.

Bookmarked links should continue to function.

Quarto#

In addition to combining the Connect guides into a single documentation site, the Connect documentation is now built with Quarto. Although things may look a bit different, the impact to the user experience is minimal.

For more information about Quarto, please see https://quarto.org/.

Notable#

In case you didn't know until now, https://docs.posit.co is internally known as "docs proper." This site acts as a gateway for new and returning users to get started with our professional products. This site mainly features install, upgrade, initial configuration and integration documentation, and links to all of our professional product guides.

Running a search from this site will not return search results from any of the admin, user, server API, release notes, etc., guides. Likewise, searching from the admin guides will not return search results from this site.

You start your journey here, on docs proper, and then migrate to the product admin guides.

Return to https://docs.posit.co when you need installation procedures, to upgrade your product, or to review our complete list of professional product resources and view previous versions of our documentation.

Docs proper also features how-to guides, pro drivers documentation, troubleshooting content, additional resources, like Install Python, and hosts documentation for other Posit products.

We understand this is a big change, and we hope it improves your documentation experience. In the future, we plan to continue the consolidation effort for our other professional products.