Skip to content

Conversation

@AmberAlston
Copy link
Member

Summary

This PR enhances the license fields documentation by transforming it from a simple reference of built-in fields into a comprehensive guide covering both built-in and custom license fields.

Key Changes

  • Added Common Use Cases section: Provides practical examples of how to use custom fields for capacity limits, feature tiers, configuration, credentials, and business logic
  • Enhanced Built-In License Fields section:
    • Added information about administrator capabilities (setting initial values, locking fields)
    • Clarified the distinction between built-in and custom fields
    • Maintained all existing field reference tables
  • Added Custom License Fields section:
    • Creating custom fields with detailed parameter explanations
    • Field types comparison table with purpose, use cases, and interface details
    • Example license YAML showing custom fields in the entitlements section
    • Instructions for accessing field values programmatically
    • API management information with link to Vendor API docs
    • Important constraints (64KB field value limit)
    • Field deletion behavior with preservation options
  • Added Customer-Specific Configuration section: Explains how individual customer values override defaults
  • Improved document structure: Better organization with clearer hierarchy using nested headings
  • Updated title: Changed from "Built-In License Fields" to "Managing Customer License Fields" to reflect broader scope

Benefits

This enhancement provides vendors with:

  • A complete reference for understanding and managing both built-in and custom license fields
  • Practical guidance on common use cases for custom fields
  • Clear examples of how license fields appear in the license YAML
  • Information about field types and when to use each one
  • Understanding of administrator capabilities and constraints

Testing Plan

  • Verify MDX syntax is valid
  • Preview documentation build to ensure proper rendering
  • Verify all internal links work correctly
  • Check that tables render properly
  • Confirm code blocks are syntax-highlighted correctly
  • Test navigation between related pages (licenses-adding-custom-fields, etc.)

🤖 Generated with Claude Code

This update transforms the built-in license fields documentation into a comprehensive guide covering both built-in and custom license fields.

Key improvements:
- Added Common Use Cases section with practical examples of custom field usage
- Enhanced Built-In License Fields section with administrator capabilities (initial values, field locking)
- Added new Custom License Fields section covering:
  - Creating custom fields with detailed parameter explanations
  - Field types table with purpose, use cases, and interface details
  - Example license YAML showing custom fields in entitlements
  - Instructions for accessing field values in applications
  - API management information
  - Important constraints (64KB limit)
  - Field deletion behavior with preservation options
- Added Customer-Specific Configuration section
- Improved document structure with better organization and hierarchy
- Changed title to "Managing Customer License Fields" to reflect broader scope

This enhancement provides vendors with a complete reference for managing license fields, from built-in fields to custom entitlements.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@netlify
Copy link

netlify bot commented Jan 28, 2026

👷 Deploy Preview for replicated-docs processing.

Name Link
🔨 Latest commit d126665
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/697a6d6b94d4a80008828d04

@netlify
Copy link

netlify bot commented Jan 28, 2026

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit d126665
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/697a6d6b94d4a80008828d08
😎 Deploy Preview https://deploy-preview-3793--replicated-docs-upgrade.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 project configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Jan 28, 2026
@AmberAlston AmberAlston deleted the enhance-license-fields-documentation branch January 28, 2026 20:14
@AmberAlston
Copy link
Member Author

claude targeted the wrong page, closing this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants