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

Add name property on registry attribute groups #978

Open
AlexanderWert opened this issue Apr 29, 2024 · 1 comment · May be fixed by #985
Open

Add name property on registry attribute groups #978

AlexanderWert opened this issue Apr 29, 2024 · 1 comment · May be fixed by #985
Assignees

Comments

@AlexanderWert
Copy link
Member

In order to automatically render readable titles for generated attributes registry docs, it would be useful to have display names for attribute groups in the YAML files (see #917 (comment)).

Proposal is to add a property name (or display_name or title) to each attributes group in the registry so that the weaver can use that property for rendering headings.

Example:


groups:
  - id: registry.aws.dynamodb
    prefix: aws.dynamodb
    type: attribute_group
    name: AWS DynamoDB
    brief: >
            This document defines attributes for AWS DynamoDB.
    attributes:
         ...
@jsuereth
Copy link
Contributor

As an FYI - in the meantime I updated the template to use the acronyms filter. This allows us to ensure things like iOS are always spelled correctly in weaver.

I still want this feature though.

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 a pull request may close this issue.

3 participants