Skip to content
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

Backport of docs: Add enterprise badge into release/0.14.x #3998

Conversation

hc-github-team-secure-boundary
Copy link
Collaborator

Backport

This PR is auto-generated from #3981 to be assessed for backporting due to the inclusion of the label backport/website.

The below text is copied from the body of the original PR.


This pull request adds enterprise badges/alerts to Boundary docs pages where it is appropriate to call out that a feature is supported only in Enterprise or HCP Boundary. The enterprise badge and enterprise alert are existing devdot web components.

I added an HCP/ENT badge to the table of contents for any topics that only apply to one of the Enterprise versions. If there are nested topics, I only applied the badge to the top level:

image

For other examples in the TOC, view:

  • Concepts > Domain model > Session recordings & Storage buckets
  • Configuration > Session recordings
  • Operations > Session recordings
  • Commands (CLI) > session-recordings & storage-buckets

At the topic level, I added an alert to any topics or sections that only applied to one of the Enterprise versions. I added the alert directly under the level 1 heading, if the whole topic was targeted to the Ent versions:

image

I can't change the Boundary logo in the alert, but I did add the text "This feature requires HCP Boundary or Boundary Enterprise" and included a link to the product page (similar to Vault).

If only one section of a topic applies to the Enterprise versions, I added the alert directly underneath the relevant heading. See the example here for Credential injection in the Credential management topic:

image

I did a find/replace for any places where we were still using the HCP/ENT "sup" tag and replaced them with the alert. There are a couple exceptions where I left an inline "sup" tag, if we used it in a sentence in a field definition. It seemed disruptive to include the alert in the middle of a paragraph. But there aren't many instances like that.

This is a manual process, so we would have to remember to add the tag/alert for new features going forward.

See the changes in the preview deployment

@hc-github-team-secure-boundary hc-github-team-secure-boundary requested review from sarahethompson and claire-labry and removed request for a team November 3, 2023 18:08
@hc-github-team-secure-boundary hc-github-team-secure-boundary merged commit 48fc0ac into release/0.14.x Nov 3, 2023
@hc-github-team-secure-boundary hc-github-team-secure-boundary force-pushed the backport/dheath-ent-nav-badge/marginally-national-squid branch from 3c4a468 to deec8b1 Compare November 3, 2023 18:08
@hc-github-team-secure-boundary hc-github-team-secure-boundary deleted the backport/dheath-ent-nav-badge/marginally-national-squid branch November 3, 2023 18:08
Copy link

github-actions bot commented Nov 3, 2023

Database schema diff between release/0.14.x and backport/dheath-ent-nav-badge/marginally-national-squid @ deec8b1

To understand how these diffs are generated and some limitations see the
documentation of the script.

Functions

Unchanged

Tables

Unchanged

Views

Unchanged

Triggers

Unchanged

Indexes

Unchanged

Constraints

Unchanged

Foreign Key Constraints

Unchanged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant