Add field to docs.json denoting available aliases #2344
Conversation
This file contains 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
- read JavaScript file defining slug/alias mapping - parse aliases object as Ruby hash - add alias key to JSON output with value or null
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.
This PR adds an "alias" key while generating https://documents.devdocs.io/docs.json, reusing the predefined aliases:
devdocs/assets/javascripts/models/entry.js
Lines 20 to 54 in 5c82069
Sample output for one doc item looks like so:
{ "name": "JavaScript", "slug": "javascript", "type": "mdn", "links": { "home": "https://developer.mozilla.org/en-US/docs/Web/JavaScript", "code": "https://github.com/mdn/content/tree/main/files/en-us/web/javascript" }, "mtime": 1724174503, "db_size": 15314120, "attribution": "© 2005–2024 MDN contributors.<br>\n Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.", "alias": "js" },This closes #2309, which provides more context on the rationale for this proposed change.
This implementation works, but could admittedly be more robust. I was hoping to avoid the aliases being defined in multiple places, and this seemed like the easiest approach to do so given we're working across JavaScript and Ruby.
Given that, if the team is open to this change, I'm happy to refactor if there's a preferred strategy. Thanks!