carbon-design-system / carbon-for-ibm-dotcom

Carbon for IBM.com is based on the Carbon Design System for IBM
https://www.ibm.com/standards/carbon/
Apache License 2.0
269 stars 156 forks source link

[Masthead]: Separate menu content from interface text in the i18n endpoint #7588

Open proeung opened 2 years ago

proeung commented 2 years ago

The problem

Treating everything as interface text

The current solution treats everything as interface text. This causes the problem that frequently changing data (or content data) will require awkward processes and workflows in GitHub by the editorial team.

Treating everything as content

This assumes that content data like the text and urls of the links lives together with text coupled to the interface (for instance the word Search in the search box). This has the problem that interface/design changes in the component will require editorial changes that must happen in sync with the release of component.

The solution

Note: This is just our initial thought, however, we're open to suggestions.

Application/website

AEM, Drupal

Business priority

Medium Priority = upcoming release but is not pressing

What time frame would this ideally be needed by (if applicable)

Examples

Example of data/text used for interfaces.

"misc": {
    "backtotop": "Back to top",
    "cancelText": "Cancel",
    "close": "Close",
    "cookiePrefs": "Cookie preferences",
    "continueText": "Continue",
    "editProfile": "Edit profile",
    "emailThisPage": "E-mail this page",
    "feedback": "Feedback",
    "mpScopedSearh": "Products",
    "withinMp": "Products",
    "next": "Next",
    "noresults": "No results found",
    "prev": "Previous",
    "resultsNav": "Use down and up arrow keys to navigate through the results.",
    "search": "Search",
    "selectCountry": "Select a country/region",
    "sharePage": "Share this page",
    "signin": "Sign in",
    "signout": "Sign out",
    "sitenav": "Site navigation",
    "welcomeback": "Welcome back"
  }

Code of Conduct

RobertaJHahn commented 2 years ago

Convert to epic, create dev research issue, AEM content support will be needed, additional issues TBD based on the solution