diff options
| author | Eric Eastwood <contact@ericeastwood.com> | 2017-11-14 16:29:33 -0600 |
|---|---|---|
| committer | Eric Eastwood <contact@ericeastwood.com> | 2017-11-15 01:55:00 -0600 |
| commit | 617c4fd94882072ec22f098c09efcdbf3e9af0cb (patch) | |
| tree | 97209186c95902f70a5816bb7df50b763292f87c | |
| parent | 9e5db3e26169dd25ae852e4197ef02ba0a3ef84a (diff) | |
| download | gitlab-ce-617c4fd94882072ec22f098c09efcdbf3e9af0cb.tar.gz | |
Add basic emoji development docs
| -rw-r--r-- | changelogs/unreleased/update-emoji-digests-with-latest-from-gemojione.yml | 6 | ||||
| -rw-r--r-- | doc/development/README.md | 1 | ||||
| -rw-r--r-- | doc/development/fe_guide/emojis.md | 27 |
3 files changed, 34 insertions, 0 deletions
diff --git a/changelogs/unreleased/update-emoji-digests-with-latest-from-gemojione.yml b/changelogs/unreleased/update-emoji-digests-with-latest-from-gemojione.yml new file mode 100644 index 00000000000..e509a8df6bc --- /dev/null +++ b/changelogs/unreleased/update-emoji-digests-with-latest-from-gemojione.yml @@ -0,0 +1,6 @@ +--- +title: 'Update emojis. Add :gay_pride_flag: and :speech_left:. Remove extraneous comma + in :cartwheel_tone4:' +merge_request: +author: +type: changed diff --git a/doc/development/README.md b/doc/development/README.md index 5690ae68e00..9b43170236f 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -22,6 +22,7 @@ comments: false - [UX guide](ux_guide/index.md) for building GitLab with existing CSS styles and elements - [Frontend guidelines](fe_guide/index.md) +- [Emoji guide](fe_guide/emojis.md) ## Backend guides diff --git a/doc/development/fe_guide/emojis.md b/doc/development/fe_guide/emojis.md new file mode 100644 index 00000000000..38794c47965 --- /dev/null +++ b/doc/development/fe_guide/emojis.md @@ -0,0 +1,27 @@ +# Emojis + +GitLab supports native unicode emojis and fallsback to image-based emojis selectively +when your platform does not support it. + +# How to update Emojis + + 1. Update the `gemojione` gem + 1. Update `fixtures/emojis/index.json` from [Gemojione](https://github.com/jonathanwiesel/gemojione/blob/master/config/index.json). + In the future, we could grab the file directly from the gem. + We should probably make a PR on the Gemojione project to get access to + all emojis after being parsed or just a raw path to the `json` file itself. + 1. Ensure [`emoji-unicode-version`](https://www.npmjs.com/package/emoji-unicode-version) + is up to date with the latest version. + 1. Run `bundle exec rake gemojione:aliases` + 1. Run `bundle exec rake gemojione:digests` + 1. Run `bundle exec rake gemojione:sprite` + 1. Ensure new sprite sheets generated for 1x and 2x + - `app/assets/images/emoji.png` + - `app/assets/images/emoji@2x.png` + 1. Ensure you see new individual images copied into `app/assets/images/emoji/` + 1. Ensure you can see the new emojis and their aliases in the GFM Autocomplete + 1. Ensure you can see the new emojis and their aliases in the award emoji menu + 1. You might need to add new emoji unicode support checks and rules for platforms + that do not support a certain emoji and we need to fallback to an image. + See `app/assets/javascripts/emoji/support/is_emoji_unicode_supported.js` + and `app/assets/javascripts/emoji/support/unicode_support_map.js` |