Which area does this feature relate to?
Documentation
Describe the feature you'd like to request
The community Building Block publishing guide currently recommends adding "keywords": ["aws-blocks"] and says that compatible BBs can be discovered with npm search keywords:aws-blocks. The same section notes that the official tag is still pending confirmation.
That discovery path is not currently usable:
npm view @aws-blocks/blocks version keywords --json returns only "0.4.0"; no keywords field is published.npm view @aws-blocks/bb-realtime version keywords --json returns only "0.1.5"; no keywords field is published.npm search keywords:aws-blocks --json --searchlimit=20 returns [].
The guide therefore instructs community authors to use a convention that cannot currently discover even first-party packages.
Relevant documentation: https://github.com/aws-devtools-labs/aws-blocks/blob/main/docs/guides/extending-with-existing-aws-resources.md#publishing-and-discoverability
Use case
An author who publishes a reusable BB needs a stable, documented way for Blocks users to find it. Conversely, a user evaluating the ecosystem should be able to use the documented discovery path and find supported packages.
Without that contract, authors cannot tell whether their package is discoverable, and consumers cannot rely on the guide's npm search instruction.
Proposed solution
Please establish one supported discovery mechanism and update the guide accordingly. For example:
- Confirm an official npm keyword, publish it on relevant first-party packages, and retain the npm search convention; or
- Replace the proposed keyword with another supported discovery mechanism, such as a curated registry or a GitHub topic.
Once the intended contract is decided, I can help with a focused documentation and/or package-metadata PR.
Alternatives considered
Authors can currently locate packages through this repository or direct links, but that does not provide a scalable discovery path for independently published Building Blocks.
Which area does this feature relate to?
Documentation
Describe the feature you'd like to request
The community Building Block publishing guide currently recommends adding
"keywords": ["aws-blocks"]and says that compatible BBs can be discovered withnpm search keywords:aws-blocks. The same section notes that the official tag is still pending confirmation.That discovery path is not currently usable:
npm view @aws-blocks/blocks version keywords --jsonreturns only"0.4.0"; nokeywordsfield is published.npm view @aws-blocks/bb-realtime version keywords --jsonreturns only"0.1.5"; nokeywordsfield is published.npm search keywords:aws-blocks --json --searchlimit=20returns[].The guide therefore instructs community authors to use a convention that cannot currently discover even first-party packages.
Relevant documentation: https://github.com/aws-devtools-labs/aws-blocks/blob/main/docs/guides/extending-with-existing-aws-resources.md#publishing-and-discoverability
Use case
An author who publishes a reusable BB needs a stable, documented way for Blocks users to find it. Conversely, a user evaluating the ecosystem should be able to use the documented discovery path and find supported packages.
Without that contract, authors cannot tell whether their package is discoverable, and consumers cannot rely on the guide's npm search instruction.
Proposed solution
Please establish one supported discovery mechanism and update the guide accordingly. For example:
Once the intended contract is decided, I can help with a focused documentation and/or package-metadata PR.
Alternatives considered
Authors can currently locate packages through this repository or direct links, but that does not provide a scalable discovery path for independently published Building Blocks.