Skip to content

Add 'What is HITRUST?' page to expand compliance content #14879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions BLOGGING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
So you're interested in contributing to the Pulumi blog? Great! Follow these
steps to make it happen.

> **Related documentation:**
> - [CONTRIBUTING.md](CONTRIBUTING.md) - General contribution guidelines
> - [STYLE-GUIDE.md](STYLE-GUIDE.md) - Comprehensive style and UX standards
> - [CODE-EXAMPLES.md](CODE-EXAMPLES.md) - Guidelines for code examples
> - [SEO.md](SEO.md) - SEO optimization checklist

## Set Up Your Development Environment

If you haven't already, clone this repository and
Expand Down
41 changes: 41 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

> **Related documentation:**
> - [CONTRIBUTING.md](CONTRIBUTING.md) - Guide for contributing to Pulumi documentation
> - [STYLE-GUIDE.md](STYLE-GUIDE.md) - Comprehensive style and UX standards
> - [BLOGGING.md](BLOGGING.md) - Instructions for writing blog posts
> - [CODE-EXAMPLES.md](CODE-EXAMPLES.md) - Guidelines for creating code examples
> - [SEO.md](SEO.md) - Search engine optimization checklist

## Essential Commands

### Build and Development
- `make ensure`: Install dependencies and build assets
- `make build`: Build the site to ./public
- `make serve`: Run Hugo server locally at http://localhost:1313

### Validation
- `make lint`: Check Markdown and other files for correctness
- `make format`: Format all applicable files

### Testing
- `make test`: Run all example program tests
- `ONLY_TEST="example-name" make test-programs`: Run a specific test

### Content Creation
- `make new-blog-post`: Generate scaffold for a new blog post
- `make new-tutorial`: Create a new tutorial page
- `make new-example-program`: Generate a new multi-language code example

## Key Guidelines

For comprehensive guidelines, please refer to the specific documentation files linked above. Here are the most critical points:

- One h1 per page, use semantic line breaks
- Place tested code examples in /static/programs/
- Use descriptive link text (no "click here" or "here")
- Create redirects with Hugo aliases when changing URLs
- Follow language-specific conventions in [STYLE-GUIDE.md](STYLE-GUIDE.md)
- Test all code examples before submitting
5 changes: 5 additions & 0 deletions CODE-EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Our documentation site at [pulumi.com/docs](http://pulumi.com/docs) provides a variety of code examples embedded within our doc pages to help users understand and apply Pulumi concepts. Ensuring the accuracy and reliability of these examples is essential, which is why we have automated testing available.

> **Related documentation:**
> - [CONTRIBUTING.md](CONTRIBUTING.md) - General contribution guidelines
> - [STYLE-GUIDE.md](STYLE-GUIDE.md) - Comprehensive style and UX standards
> - [BLOGGING.md](BLOGGING.md) - Guidelines for blog posts that might include code examples

In order to get automated testing of your code example, the code must be added to a specific directory, and integrated into the document with a [Hugo shortcode](https://gohugo.io/content-management/shortcodes/). Once added, code examples are tested through an [automated pipeline](https://github.com/pulumi/docs/blob/master/.github/workflows/pull-request.yml) on a [regular cadence](https://github.com/pulumi/docs/blob/master/.github/workflows/scheduled-test.yml) to maintain ongoing accuracy.

## How it works
Expand Down
62 changes: 61 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
# Contributing Pulumi Documentation
# Contributing to Pulumi Documentation

This guide will help you contribute to Pulumi's documentation. Use the navigation below to find what you need quickly.

**Quick navigation:**
- [Documentation Overview](#documentation-structure)
- [Creating Links](#links-to-other-files)
- [Hugo Tips](#hugo-tips)
- [Style Guidelines](#style-guide)
- [Writing Blog Posts](BLOGGING.md)
- [Writing Code Examples](CODE-EXAMPLES.md)
- [Style Guide (Comprehensive)](STYLE-GUIDE.md)

## What would you like to do?

- **Edit existing content:** Follow our [style guide](#style-guide) and use [Hugo's relref shortcode](#links-to-other-files) for internal links
- **Add new content:** Understand our [documentation structure](#documentation-structure) and use our [Hugo tips](#hugo-tips)
- **Test your changes:** Run `make serve` to preview changes locally at http://localhost:1313
- **Write a blog post:** See the [blogging guide](BLOGGING.md)

## Pulumi terminology

Expand Down Expand Up @@ -51,6 +69,40 @@ Which, on a page inside the `./content/reference` directory, will generate:

- **no_on_this_page** Specify this variable to prevent displaying an "On This Page" TOC on the right nav for the page.
- **block_external_search_index** Specify this variable to prevent crawlers from indexing the page.

## Testing your changes

To see how your changes look locally before submitting a pull request:

```bash
# Install dependencies and build assets
make ensure

# Run the development server
make serve
```

Then visit http://localhost:1313 to preview your changes.

## Common commands

```bash
# Build the entire website
make build

# Run linting on Markdown and other files
make lint

# Format all applicable files
make format

# Run all tests
make test

# Test specific programs
ONLY_TEST="example-name" make test-programs
```

## Style guide

### Language and terminology styles
Expand Down Expand Up @@ -84,3 +136,11 @@ If a tutorial has more following tutorials, use a **Next steps** section at the
## Blog Post Authoring

For instructions on contributing to the [Pulumi blog](https://www.pulumi.com/blog/), [see BLOGGING.md](BLOGGING.md).

## Additional Resources

For more detailed guidance, please refer to:

- [Style Guide](STYLE-GUIDE.md) - Comprehensive style and UX standards
- [Code Examples](CODE-EXAMPLES.md) - Guidelines for writing code examples
- [SEO Guidelines](SEO.md) - Search engine optimization guidance
13 changes: 12 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,18 @@ build:
check_links:
$(MAKE) banner
$(MAKE) ensure
./scripts/link-checker/check-links.sh "https://www.pulumi.com"
./scripts/link-checker/check-links.sh "https://www.pulumi.com" "$(SECTION)"

# Usage: make check_section SECTION=/docs/
.PHONY: check_section
check_section:
@if [ -z "$(SECTION)" ]; then \
echo "Error: SECTION variable is required. Example: make check_section SECTION=/docs/"; \
exit 1; \
fi
$(MAKE) banner
$(MAKE) ensure
./scripts/link-checker/check-links.sh "https://www.pulumi.com" "$(SECTION)"

.PHONY: check_search_urls
check_search_urls:
Expand Down
10 changes: 10 additions & 0 deletions SEO.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# SEO Guidelines

This document provides a checklist for search engine optimization (SEO) of Pulumi documentation, blog posts, and other web content.

> **Related documentation:**
> - [CONTRIBUTING.md](CONTRIBUTING.md) - General contribution guidelines
> - [STYLE-GUIDE.md](STYLE-GUIDE.md) - Comprehensive style and UX standards
> - [BLOGGING.md](BLOGGING.md) - Guidelines for blog posts
> - [CODE-EXAMPLES.md](CODE-EXAMPLES.md) - Guidelines for code examples

## SEO Checklist

- [ ] Identify whether the intent of the piece is informational, preferential, navigational, or transactional
Expand Down
27 changes: 22 additions & 5 deletions STYLE-GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Style Guide

This document defines some general styles we adhere to in the docs.
This document defines general styles and user experience (UX) standards we adhere to in the Pulumi documentation, marketing website, and registry.

> **Related documentation:**
> - [CONTRIBUTING.md](CONTRIBUTING.md) - Guide for contributing to Pulumi documentation
> - [BLOGGING.md](BLOGGING.md) - Instructions for writing blog posts
> - [CODE-EXAMPLES.md](CODE-EXAMPLES.md) - Guidelines for creating code examples
> - [SEO.md](SEO.md) - Search engine optimization checklist

## Language

Words are important. Pulumi strives to use language that is clear, harmonious, and friendly to all readers. With these goals in mind, we use the following guidelines:
Words are important. Pulumi strives to use language that is clear, harmonious, and friendly to all readers. With these goals in mind, we use the following guidelines:

* Avoid ableist language:
* Instead of _crazy_ try _wild_.
Expand All @@ -21,13 +27,18 @@ Words are important. Pulumi strives to use language that is clear, harmonious, a

* Ensure that readers are able to scan the headings of a page and get an effective overview of the page's content.
* Every page should have exactly one `h1`.
* Headings levels should only increment one level at a time. E.g., if your previous heading level was an `h2`, the next heading must be an `h2` or an `h3`, but not, e.g., an `h4` or `h5`.
* Headings levels should only increment one level at a time. E.g., if your previous heading level was an `h2`, the next heading must be an `h2` or an `h3`, but not, e.g., an `h4` or `h5`.
* Docs and registry headings should use sentence case (i.e., first letter of the first word is capitalized).

## Links
## Links and Buttons

* Link text should be descriptive and have meaning outside of the surrounding context: Avoid link text like _here_, _click here_, _see here_ and instead link to the title of the linked page, e.g. "see [Pulumi Pricing](https://www.pulumi.com/pricing/)". (While this practice benefits all readers, it is of particular importance for visually impaired users who use screen readers and often jump through the links of a document.)
* When changing the URL for an already existing page, add a redirect by using a [Hugo alias](https://gohugo.io/content-management/urls/#yaml-front-matter).
* Use descriptive text for button labels and links, and avoid generic labels such as "Learn more."
* Use unique labels for distinct actions - having two buttons with the same label that take different actions is confusing to users.
* Links should take you to another page, and buttons should take an action on the page.
* When possible, links should look like links, and buttons should look like buttons.
* When not a special case (e.g., navigation), links should exist within the context of text.

## Notes and Warnings

Expand Down Expand Up @@ -58,6 +69,7 @@ This bit of info is serious. If you missed it, bad things could happen.
## Paragraphs and Line Breaks

* Keep paragraphs short, rarely use 4 or more sentences in a single paragraph.
* Use line lengths between 45 – 75 characters (this is in reference to the rendered page, not the markdown).

* When writing paragraphs and long sentences, use one of the following:

Expand Down Expand Up @@ -126,13 +138,18 @@ This bit of info is serious. If you missed it, bad things could happen.
## Content Design

* Lead with content that excites and engages, end with exactly one call-to-action.
* Every page should have no more than one primary action.
* Try and save links for the last 75% of the content.
* Use headings and lists to make content scannable and consumable.
* Use visuals: code, graphs, videos, architecture diagrams, etc.
* Highlight important points.
* Avoid emojis unless for notes or absolutely necessary.

## Component Usage

* Use existing components, or improve existing components over creating new components unless you identify a need that is not solveable with the current components.

## Additional Resources

* Markdownlint will help enforce syntactically valid Markdown and is available as a [CLI tool](https://github.com/igorshubovych/markdownlint-cli#installation) or as a [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint).
* [Writing inclusive documentation](https://developers.google.com/style/inclusive-documentation) (Google).
* [Writing inclusive documentation](https://developers.google.com/style/inclusive-documentation) (Google).
100 changes: 100 additions & 0 deletions content/what-is/what-is-hitrust.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
---
title: What is HITRUST?
meta_desc: |
Understand what HITRUST is, its Common Security Framework (CSF), benefits for healthcare organizations, and how it helps with regulatory compliance.
type: what-is
page_title: "What is HITRUST?"
---

HITRUST, or the Health Information Trust Alliance, is a private company that provides a certification and framework called the HITRUST CSF (Common Security Framework) to help organizations manage data, information risk, and compliance, particularly in the healthcare sector. **HITRUST aims to provide a standardized approach for managing risk and demonstrating compliance with various regulations, including HIPAA and the HITECH Act.**

Before HITRUST, healthcare organizations often struggled with multiple overlapping compliance frameworks and requirements. Each regulatory body and business partner might require different security assessments, creating inefficiencies and redundancies. HITRUST was established to provide a unified, comprehensive framework that incorporates and harmonizes requirements from multiple regulations and standards.

In this article, we'll explore four key aspects of HITRUST:

* [What is HITRUST and why is it important?](#what-is-hitrust-and-why-is-it-important)
* [The HITRUST CSF and its key components](#the-hitrust-csf-and-its-key-components)
* [Benefits of HITRUST certification](#benefits-of-hitrust-certification)
* [Challenges in achieving HITRUST compliance](#challenges-in-achieving-hitrust-compliance)

## What is HITRUST and why is it important?

HITRUST is a private organization founded in 2007 with a mission to champion programs that safeguard sensitive information and manage information risk for global organizations across all industries. Its most notable contribution is the HITRUST CSF, a certifiable framework that helps organizations demonstrate compliance with various regulations.

The importance of HITRUST stems from the increasing regulatory pressure on healthcare organizations and their business associates to protect sensitive patient information. With the digitization of health records and the growing number of data breaches, organizations need a structured approach to:

* Ensure compliance with HIPAA and other regulatory requirements
* Protect sensitive patient data from security threats
* Demonstrate their security posture to business partners and regulators
* Manage the complex landscape of information security requirements

HITRUST has become particularly important in healthcare because it incorporates requirements from HIPAA and the HITECH Act, making it easier for covered entities and business associates to demonstrate compliance with these regulations.

## The HITRUST CSF and its key components

The HITRUST CSF is a comprehensive, certifiable framework that incorporates nationally and internationally accepted standards including:

* ISO 27001/27002
* NIST SP 800-53
* PCI DSS
* HIPAA
* HITECH Act
* Various state regulations and industry best practices

The framework is organized into 14 control categories with over 150 control specifications that can be tailored based on an organization's specific risk factors including:

* Organization type
* Size of the organization
* Geographic location
* Data sensitivity
* Systems and regulatory requirements

The HITRUST CSF employs a maturity model approach, evaluating controls across five maturity levels:

1. **Policy** - Documented policies that address the control requirements
2. **Procedures** - Documented procedures to implement the policies
3. **Implementation** - Controls actually implemented in systems and processes
4. **Measurement** - Testing and measuring the effectiveness of controls
5. **Management** - Oversight and continuous improvement of controls

This approach allows organizations to not just implement controls but to demonstrate that they are functioning effectively and continuously improving over time.

## Benefits of HITRUST certification

Organizations that achieve HITRUST certification realize several key benefits:

* **Comprehensive compliance** - A single assessment can help demonstrate compliance with multiple regulatory requirements, reducing the need for multiple assessments
* **Standardized approach** - The framework provides a structured, consistent methodology for security and compliance
* **Risk reduction** - Implementation of the comprehensive controls helps reduce the likelihood and impact of security incidents
* **Competitive advantage** - Certification can differentiate an organization in the marketplace and simplify vendor selection processes
* **Inheritable controls** - Organizations can leverage third-party assessments through inheritance, potentially reducing assessment scope and efforts
* **Third-party validation** - Independent assessment provides credibility to security claims
* **Streamlined business associate agreements** - Can simplify contractual requirements with business partners

HITRUST offers different levels of assessment, including self-assessment, validated assessment, and certified assessment, giving organizations flexibility in how they approach the framework based on their business needs.

## Challenges in achieving HITRUST compliance

Despite its benefits, achieving HITRUST certification presents several challenges:

* **Complexity and scope** - The framework is extensive and detailed, requiring significant resources to implement
* **Documentation requirements** - Extensive documentation is needed to demonstrate both the existence and effectiveness of controls
* **Cost and time commitment** - The certification process can be expensive and time-consuming
* **Subjectivity in interpretation** - The framework's requirements can sometimes be vague and open to interpretation
* **Continuous maintenance** - Controls must be continuously monitored and improved to maintain certification
* **Limited automation options** - Many control requirements involve processes that cannot be fully automated
* **Resource intensity** - The assessment process requires dedicated resources with specific expertise

Organizations pursuing HITRUST certification often need to engage specialized consultants and allocate dedicated internal resources to navigate the process successfully.

## Learn more

HITRUST provides a comprehensive framework for managing information security risks and demonstrating regulatory compliance, particularly in the healthcare sector. By adopting HITRUST, organizations can streamline their compliance efforts and build trust with partners and customers.

Pulumi's infrastructure as code solutions can help with implementing some of the technical controls required by HITRUST, especially around infrastructure security, configuration management, and automated compliance verification. [Learn how Pulumi supports security and compliance](/docs/iac/using-pulumi/crossguard/).

For more information about compliance-related topics:

* [What is Configuration Management?](/what-is/what-is-configuration-management)
* [What is Secrets Management?](/what-is/what-is-secrets-management)
* [What is Cloud Infrastructure Autoscaling?](/what-is/what-is-cloud-infrastructure-autoscaling)
Loading
Loading