Use @name formatting for add-on IDs#2125
Merged
Merged
Conversation
Contributor
Author
|
Blocked by #2022. Once that lands, this should be rebased. |
Historically add-ons documentation has used email address-style ID names. This has created confusion among developers and lead to a variety of incorrect assumptions about the requirements, behaviors, limitations, and validation steps associated with these IDs. In order to sidestep the confusion created by this format, this commit replaces replaces the email convention (e.g. addon-name@example.com) with a simpler @-prefixed ID (e.g. @example). This should better communicate that the ID needs to be a unique value in a global namespace while still enabling developers to choose human-readable names for their add-ons.
Contributor
Author
|
#2022 has been merged and this PR is has been rebased on top of the updated on top of the master branch. I also updated the template to replace inline HTML with the appropriate set of liquid templates. This addresses a minor issue where this page's table of contents appeared halfway the page rather than below the header. |
This should be addressed in a separate update.
Contributor
Author
|
@rebloor, if you could, that would help quite a bit. Hm, I guess we should also apply this to the examples repo. I'll start looking at that now. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Historically add-ons documentation has used email address-style ID names. This has created confusion among developers and lead to a variety of incorrect assumptions about the requirements, behaviors, limitations, and validation steps associated with these IDs.
In order to sidestep the confusion created by this format, this commit replaces replaces the email convention (e.g. addon-name@example.com) with a simpler @-prefixed ID (e.g. @example). This should better communicate that the ID needs to be a unique value in a global namespace while still enabling developers to choose human-readable names for their add-ons.