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

DOC-1116 Load license enterprise license key from environment variable #204

Merged
merged 2 commits into from
Mar 27, 2025

Conversation

asimms41
Copy link
Contributor

@asimms41 asimms41 commented Mar 19, 2025

Description

Resolves DOC-1116
Review deadline: 21 March

This pull request includes updates to the licensing documentation to improve clarity and provide additional instructions for applying and verifying a Redpanda license.

Documentation improvements:

  • Clarified the instructions for setting the REDPANDA_LICENSE_FILEPATH environment variable by removing unnecessary syntax.
  • Updated the section title from "Apply the license using an inline license string" to "Apply the license using a license string" for better readability.
  • Added an alternative method for applying a license if a license key file is not available, including setting the REDPANDA_LICENSE environment variable.
  • Provided an example log output to help users verify the license key’s expiration date in the Redpanda Connect logs.

Page previews

Enterprise Licensing

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Copy link

netlify bot commented Mar 19, 2025

Deploy Preview for redpanda-connect ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-connect/deploys/67e554ffb90b233239423bf6
😎 Deploy Preview https://deploy-preview-204--redpanda-connect.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

hyperlint-ai bot commented Mar 19, 2025

PR Change Summary

Updated licensing documentation to include loading enterprise license keys from environment variables.

  • Modified instructions for applying a license key to include setting environment variables.
  • Clarified the process for using a license string when a license key file is not available.
  • Added an example log output for verifying license key status.

Modified Files

  • modules/get-started/pages/licensing.adoc

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@asimms41 asimms41 requested review from mihaitodor and rockwotj March 20, 2025 10:43
@asimms41 asimms41 marked this pull request as ready for review March 20, 2025 10:43
@asimms41 asimms41 requested a review from a team as a code owner March 20, 2025 10:43
Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@asimms41 asimms41 merged commit 2a8d030 into main Mar 27, 2025
10 checks passed
@asimms41 asimms41 deleted the DOC-1116_Load_license_key_from_env_var branch March 27, 2025 13:50
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.

3 participants