Content

Our content designers help users connect with products and communities in an authentic, intuitive, and enjoyable way.

About content
17 Microcopy Snippets

Alert within a wizard: Configuration limits

Katie Edwards

Alert within a wizard: Configuration limits
Kafka
User context

Communicates replica and minimum in-sync replica requirements to user in Kafka topic creation process.

Microcopy

Streams for Apache Kafka configures topics with 3 replicas and 2 minimum in-sync replicas. 
 

Resources Jira

All broken links across the product

Andrew Ronaldson

404 error page
Kafka
User context

Informs user that the page is no longer active.

Microcopy

404: That page doesn’t exist.

We can’t find the page you’re looking for. 

[Return to home page]

Cluster creation button

Kaelan Khiatani

Required to start using assisted installer
Assisted Installer
User context

Gives the choice to users whether they want to create a cluster using Openshift or on a local server.

Microcopy

Assisted Installer

The easiest way to install OpenShift on your own infrastructure with step-by-step guidance, preflight validations, and smart defaults. This method supports multiple architectures.

Create cluster Run Agent-based Installer locally

Resources No resource available

Discovery ISO inline alert

Kaelan Khiatani

Appears automatically after generating an ISO.
Assisted Installer
User context

An alert to let the user know that their ISO is ready to be downloaded.

Microcopy

Add hosts

Discovery ISO is ready to be downloaded

Adding hosts instructions

  1. Download the Discovery ISO (onto a USB drive, attach it to a virtual media, etc.) and use it to boot your hosts.
  2. Keep the Discovery ISO media connected to the device throughout the installation process and set each host to boot only one time from this device.
  3. Booted hosts should appear in the host inventory table. This may take a few minutes.
Resources No resource available

Discovery ISO URL clipboard copy

Kaelan Khiatani

Appears after the user has generated an ISO for easy access.
Assisted Installer
User context

Provides the user with the URL of their ISO.

Resources No resource available

Empty state

Andrew Ronaldson

Empty state: Service down message
OpenShift
User context

Informs user that the service is down (any reason/no known reason).

Microcopy

Service unavailable

We're working on getting the service back up again. In the meantime, check for updates on the status page.

Visit status page

Resources No resource available

Empty state: Permission needed

Allison Wolfe

Permissions needed
Trusted Application Pipeline
User context

A user is trying to access a workspace they do not have permissions for and they come across this empty state.

Microcopy

“Ask the administrator or the owner of the crt-redhat-acm workspace for access permissions." CTA: “Go to Overview page”

Resources No resource available

Encryption switch select

Kaelan Khiatani

Optional in the creation of a cluster. Allows the user to encrypt their cluster.
Assisted Installer
User context

Gives the user the choice in encrypting their clusters or not using one or both methods.

Microcopy

Encryption of installation disks

Control plane nodes

Workers

Resources No resource available

Inline alert error: Maximum length

Andrew Ronaldson

Text input that uses a max character limit.
OpenShift
User context

Character limiting on fields

Microcopy

Cannot exceed [maximum length] characters.

Resources No resource available

Manage access > Add permission dropdown menu

Katie Edwards

Permission option to assign to all accounts
Kafka
User context

Enables the user to add the "Consume from a topic" permission to all accounts.

Microcopy

Consume from a topic

Network config radio

Kaelan Khiatani

Required in the process of creating a cluster
Assisted Installer
User context

Allows users to customize their cluster's network configuration using the radio select.

Microcopy

Hosts' network configuration

DHCP only Static IP, bridges, and bonds

Resources No resource available

Openshift version selection dropdown select

Kaelan Khiatani

Required to host a cluster with Openshift.
Assisted Installer
User context

Allows the user to select which version of Openshift to install

Microcopy

OpenShift version 

*OpenShift 4.13.2

Learn more about OpenShift releases

Resources No resource available

Service accounts for streams

Allison Wolfe

Tooltip: Delete service account
Kafka
User context

Informs user that they don't have permissions to delete the service account - only admins and owner can.

Microcopy Organization administrations and the service account owner can delete this service account.

SSH public key file upload

Kaelan Khiatani

Optional in the creation of a cluster. Allows the user to add authentication to access their cluster.
Assisted Installer
User context

Allows the user to add a public SSH key authentication requirement to access their cluster.

Microcopy

SSH public key

 

Paste the content of a public ssh key you want to use to connect to the hosts into this field. Learn more 

Resources No resource available

Text Input for cluster name and domain name

Kaelan Khiatani

Required in the process of creating a cluster
Assisted Installer
User context

Area where users can input the name of their cluster and the name of the domain that the cluster will be hosted on.

Microcopy

Cluster details

Cluster name *

Base domain *

All DNS records must be subdomains of this base and include the cluster name. This cannot be changed after cluster installation. The full cluster address will be:
[Cluster Name].[example.com]

Resources No resource available

Tour popover

Allison Wolfe

Popover: during a product tour
OpenShift
User context

A popover during a guided tour to explain the product to a new user

Microcopy

Perspective switcher

In the development perspective, you can build applications, components, and services; define how they work together; and monitor their health over time.

In the administrator perspective, you can manage workload storage, networking, cluster settings, and more.


Resources No resource available

Warning popover

Allison Wolfe

Erasing disk
Anaconda
User context

The user is installing onto a disk and it will erase the data

Microcopy

To prevent loss, make sure to backup your data

Erasing the disks cannot be undone.

Resources No resource available