Skip to content

Update administration console documentation tags #152

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

Merged
merged 1 commit into from
Jul 9, 2025

Conversation

magicalyak
Copy link
Contributor

Summary

This PR updates the tags for all administration console documentation files to improve organization and discoverability.

Changes Made

Standardization

  • Added tag across all console-related files for consistency
  • ✅ **Replaced with ** for better specificity
  • Enhanced semantic categorization with relevant tags

Tag Updates by Category

Authentication & SSO Files:

  • Added , Usage: security [-h] [-i] [-l] [-p prompt] [-q] [-v] [command] [opt ...]
    -i Run in interactive mode.
    -l Run /usr/bin/leaks -nocontext before exiting.
    -p Set the prompt to "prompt" (implies -i).
    -q Be less verbose.
    -v Be more verbose about what's going on.
    security commands are:
    help Show all commands, or show usage for a command.
    list-keychains Display or manipulate the keychain search list.
    list-smartcards Display available smartcards.
    default-keychain Display or set the default keychain.
    login-keychain Display or set the login keychain.
    create-keychain Create keychains and add them to the search list.
    delete-keychain Delete keychains and remove them from the search list.
    lock-keychain Lock the specified keychain.
    unlock-keychain Unlock the specified keychain.
    set-keychain-settings Set settings for a keychain.
    set-keychain-password Set password for a keychain.
    show-keychain-info Show the settings for keychain.
    dump-keychain Dump the contents of one or more keychains.
    create-keypair Create an asymmetric key pair.
    add-generic-password Add a generic password item.
    add-internet-password Add an internet password item.
    add-certificates Add certificates to a keychain.
    find-generic-password Find a generic password item.
    delete-generic-password Delete a generic password item.
    set-generic-password-partition-list Set the partition list of a generic password item.
    find-internet-password Find an internet password item.
    delete-internet-password Delete an internet password item.
    set-internet-password-partition-list Set the partition list of a internet password item.
    find-key Find keys in the keychain
    set-key-partition-list Set the partition list of a key.
    find-certificate Find a certificate item.
    find-identity Find an identity (certificate + private key).
    delete-certificate Delete a certificate from a keychain.
    delete-identity Delete an identity (certificate + private key) from a keychain.
    set-identity-preference Set the preferred identity to use for a service.
    get-identity-preference Get the preferred identity to use for a service.
    create-db Create a db using the DL.
    export Export items from a keychain.
    import Import items into a keychain.
    export-smartcard Export items from a smartcard.
    cms Encode or decode CMS messages.
    install-mds Install (or re-install) the MDS database.
    add-trusted-cert Add trusted certificate(s).
    remove-trusted-cert Remove trusted certificate(s).
    dump-trust-settings Display contents of trust settings.
    user-trust-settings-enable Display or manipulate user-level trust settings.
    trust-settings-export Export trust settings.
    trust-settings-import Import trust settings.
    verify-cert Verify certificate(s).
    authorize Perform authorization operations.
    authorizationdb Make changes to the authorization policy database.
    execute-with-privileges Execute tool with privileges.
    leaks Run /usr/bin/leaks on this process.
    error Display a descriptive message for the given error code(s).
    create-filevaultmaster-keychain Create a keychain containing a key pair for FileVault recovery use.
    smartcards Enable, disable or list disabled smartcard tokens.
    translocate-policy-check Check whether a path would be translocated.
    translocate-status-check Check whether a path is translocated.
    translocate-original-path Find the original path for a translocated path.
    requirement-evaluate Evaluate a requirement against a cert chain.
    filevault Handles FileVault specific settings and overrides.
    platformsso Handles Platform SSO specific settings and overrides., tags
  • Replaced →
  • Removed redundant tags where appropriate

Configuration Files:

  • Added , , tags
  • Standardized categorization approach

Feature & Plan Files:

  • Added , , tags
  • Removed generic and tags
  • Enhanced with specific semantic tags

Console Management Files:

  • Added , , tom tags
  • Improved categorization for different user journeys

Files Updated (14 total)

    • Added administration, security
    • Standardized azure-ad tagging
    • Added security, configuration, troubleshooting
    • Added configuration, users
    • Added getting-started, overview, billing, networking, automation
    • Enhanced with billing, limitations, networking, automation
    • Added configuration, billing
    • Reordered tags for consistency
    • Added administration, configuration
    • Standardized authentication tagging
    • Added administration tag
    • Added configuration, automation
    • Simplified and focused tags
    • Added administration tag

Benefits

  1. Improved Discoverability - Users can find related content more easily
  2. Consistent Categorization - All console docs follow same tagging pattern
  3. Better Navigation - Enhanced semantic tags support better filtering
  4. Future-Proof - Standardized approach scales with more content

Testing

  • ✅ All files validated for proper YAML frontmatter
  • ✅ Tags follow established semantic categories
  • ✅ No breaking changes to existing functionality

- Standardize 'administration' tag across all console-related files
- Replace 'azure' with 'azure-ad' for consistency
- Add semantic tags like 'configuration', 'security', 'billing', 'networking', 'automation'
- Remove redundant tags like 'free-plan', 'rbac', 'features' where appropriate
- Enhance categorization to improve content discoverability

Files updated:
- azure-ad-sso-setup.md
- azure-group-mapping.md
- console-access.md
- console-administration.md
- console-overview.md
- free-plan-features.md
- free-plan-new-user.md
- managing-hostnames.md
- netbox-cloud-plugins.md
- okta-group-mapping.md
- okta-sso-setup.md
- prefix-lists.md
- public-ip-addressing.md
- saml-group-map.md
@magicalyak magicalyak requested review from weyrick and a team as code owners July 9, 2025 16:40
@magicalyak magicalyak merged commit a70cd19 into main Jul 9, 2025
2 checks passed
@magicalyak magicalyak deleted the update-administration-console-tags branch July 9, 2025 16:41
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.

2 participants