Hi, you can delete me now.

Term issue

Feedback on this repo:

• When you create an issue, it only gives you the option to update existing terms or create new ones. Neither of those scenarios were right for this issue.
• The contributing.md file suggests that you create an issue by clicking the "Give us feedback" link on the page. I don't see that on the glossary page anywhere.
• In contributing.md we should instruct users which branch to use for branching off of and pushing to (develop).
• We should tell them to edit the terms in the _converted directory, not the terms directory (though I hear terms may be removed soon anyway).
• In the contributing.md the readMore attribute is included in the key-value pair table but not in the sample. Could be useful to see that.
• The PR descrip form doesn’t comment out the instructions. Didn’t know if you wanted those to appear in every finished PR descrip.
• There is no default reviewer. Will contributors know to ask James to review it? We should consider that.

Terms and definitions

Term:

What's wrong:

• Incorrect definition
• Incorrect related links
• Incorrect tagging
• Other (please specify)

Additional information/resources

Problem

The project contains files that need to be removed or renamed.

Proposed solution

• Remove the json-to-markdown script. This is no longer needed.
• Delete the src/terms directory, which has the old JSON source. These are no longer used anywhere.
• Rename the src/_converted directory into src/terms and update build code to handle change.

Expected outcome

Project should still be able to successfully build the site with the same content.

Reference: https://magento.github.io/glossary/index.html?#9fceecbe-31be-4e49-aac7-11d155a85382

A snippet of code that adds a feature or functionality to a store. For example, a merchant might add a Facebook "Like" plug-in to a store. A plugin, or interceptor, is a class that modifies the behavior of public class functions by intercepting a function call and running code before, after, or around that function call.

Problem

There is no linting done on the markdown content of the project making the format varied and hard to read/review sometimes.

Proposed Solution

• Add a markdown linter to the project

Expected Outcome

A markdown linter is added to the project along with an npm command for running it.

NOTE:
There is no expectations for fixing the current content based on linting results.
In fact, it is not recommended to add such a change in a PR for this issue as it will make it hard to review.

We often use separate names for code that is customer-specific, eg developer by SI for specific site (we call it customization) and general-purpose plug-in, that can be used by several merchants, might be also published in the marketplace (extension).

Issue

The glossary contains many terms that do not require definitions such as Adobe, PHP, API.

Expected results

1. Use this issue to create a list of the terms to be removed, and approve the list with the Commerce Docs and Knowledge base teams.
2. Create a pull request that removes the approved list of terms from the glossary

Class that replaces Data Value. Textual data is extracted from the given argument and returned in the form of an object belonging to the Phrase class.

#3208

Problem

The site's 404 page currently does not fit the rest of the app.

Possible solution

Modify the src/pages/404.js component to use the same App component as the rest of the site.

Expected outcome

A 404 page that looks like the rest of the site.

Include definitions for:

• Product Detail Page (PDP)
• Category Listing Page (CLP)

Typo in the definition.

Problem

There is no API that provides just the term data.
Having this feature will allow the app to integrate with external sites and services, such as the core devdocs site or even the Magento admin panel.

Possible solution

Modify the build logic to create static, individual routes under glossary.magento.com/data that return only JSON data.

Expected outcome

A static API service that provides data to external consumers.

Problem

A favicon is currently missing from the site.

Proposed Solution

Use the same favicon file(s) from the Magento DevDocs site and copy into the appropriate place in the the project.

Expected outcome

When the site is built, the Magento favicon should be displayed in the browser.