[skip changelog] Use generally applicable name for package index specification #1137
Conversation
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
…ification Previously the name of the specification was "package_index.json specification". Only the primary official package index is allowed to be named package_index.json, but this specification applies to all package indexes. So "Arduino package index specification" (shortened to "Package index specification" in the documentation navigaion pane) is less likely to cause confusion and also easier to remember and talk about.
silvanocerza
approved these changes
Jan 14, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)docs update
The name of the specification is "package_index.json specification". Only the primary official package index
is allowed to be named package_index.json, but this specification applies to all package indexes. So the current naming might cause confusion. It also doesn't roll off the toungue so well when speaking about this topic.
The specification is renamed to "Arduino package index specification" (shortened to "Package index specification" in the documentation website navigaion pane). This name is less likely to cause confusion and also easier to remember and talk about.
The filename of the specification was not changed in order to avoid breaking links.
titled accordingly?
No