openedx / openedx/paragon

Deprecate Non-Boostrap Brand Icons

Open
#2,346 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
140
Forks
100
Avg merge
1h 3m
Merged PRs (30d)
30

Description

The new Brand Icons page allows the user to search for a brand icon, and the page returns a single icon, ie "facebook":

Image

The existing Icons page also allows the user to search for the new Bootstrap brand icons, however this page returns multiple brand icons, including the new ones from Bootstrap Icons. Also, the previously existing brand icons are not sized correctly (24x24).

Image

Task:

  • either deprecate prior brand icons that are not bootstrap and point current users of brand icons to the new brand icons
    , alias the original import to the new Bootstrap icon import instead, or hide them from the docsite to discourage consumers from using the non Boostrap brand icons.

Currently leaning towards just hiding on docs site in the short term to avoid breaking changes

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Brand Icons and Icons documentation pages and compare how each search result is sourced. Confirm the short-term choice to hide non-Bootstrap brand icons without breaking existing imports; done means the old icons no longer appear in the docsite and Bootstrap brand icons remain searchable.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation, frontend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.