Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

💄 fix: Added shortcodes for CAUTION and IMPORTANT admonition #83

Merged
merged 3 commits into from
Apr 5, 2022

Conversation

BeeBombshell
Copy link
Contributor

Fixes #64 and #66

Changes:

The PR adds shortcodes for CAUTION and IMPORTANT admonition blocks.

Screenshot of the change:

image

To test if the new admonitions are properly working, the following code can be used:

{{< notice important >}}
  This is a simple important.
{{</ notice >}}

{{< notice caution >}}
  This is a simple caution.
{{</ notice >}}

@BeeBombshell
Copy link
Contributor Author

@jwflory, Kindly review and suggest if there are any changes that need to be added. 😊

@Neha9849
Copy link
Member

@BeeBombshell that looks great!!
Currently we are using only one icon for all admonition blocks, I would suggest changing the icons in accordance with the admonition for to enhance user experience.
I would also suggest adding demo of this shortcodes in the elements page as added for other admonitions, so that it would be helpful for others.
@jwflory what do you think?

@BeeBombshell
Copy link
Contributor Author

Thanks, @Neha9849 I think that's a good suggestion!
If you and @jwflory approve, then I can go ahead and either create a new issue for the above-mentioned changes (demo + icons) or add commits to the same PR. 😄

@jwflory jwflory self-assigned this Mar 30, 2022
@jwflory jwflory added the T: new change Adds new capabilities or functionality label Mar 30, 2022
@jwflory
Copy link
Member

jwflory commented Mar 30, 2022

@BeeBombshell wrote…
The PR adds shortcodes for CAUTION and IMPORTANT admonition blocks.

Thanks, this change is looking good. It adds support for the admonitions built into Asciidoc, but these shortcodes can be used in both Markdown and Asciidoc content. 🙌🏻

@Neha9849 wrote…
Currently we are using only one icon for all admonition blocks, I would suggest changing the icons in accordance with the admonition for to enhance user experience.

@BeeBombshell wrote…
I can go ahead and either create a new issue for the above-mentioned changes (demo + icons) or add commits to the same PR. smile

+1. We can use @Yavnikaa's mockup she designed here in #64 as a reference. She also found an open source icon set we could use, Feather Icons, for logos.

The best approach here will be to add commits to the same PR. Since the design prep is done, we can go straight to implementation. This Pull Request can become a general rework of admonitions across the theme.

@Neha9849 wrote…
I would also suggest adding demo of this shortcodes in the elements page as added for other admonitions, so that it would be helpful for others.

This was also my other piece of feedback. More docs 😀 We can document the new admonitions by adding an example in the Elements page.

@BeeBombshell
Copy link
Contributor Author

Hi @jwflory, I was going through the project and I found out that the project is already using the Themify Icons Set. So I tried to incorporate these icons into the admonition shortcodes. Kindly take a look and share your reviews! 😄

image

@jwflory
Copy link
Member

jwflory commented Mar 31, 2022

@BeeBombshell Looks great 👍🏻 Please push up your code and I will move the review forward 🙌🏻

@BeeBombshell
Copy link
Contributor Author

@jwflory I've added the above-mentioned changes. Kindly review... 😄

@BeeBombshell
Copy link
Contributor Author

@jwflory I revoked the changes that were accidentally made. Please take a look! ☺️

BeeBombshell and others added 2 commits April 4, 2022 23:48
* 💄 fix: Added CAUTION admonition shortcode
* 💄 fix: Added IMPORTANT admonition shortcode
* 💄 fix: Added admonition icons and updated docs
Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>
Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>
Copy link
Member

@jwflory jwflory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @BeeBombshell, this looks good! I pushed a new commit to remove some of the other changes made by the IDE. But I cloned this locally and the new admonitions look great. Nice work! 🚀

Merging. 🎬

@jwflory jwflory merged commit 3f140d3 into unicef:main Apr 5, 2022
jwflory added a commit to Neha9849/inventory-hugo-theme that referenced this pull request Apr 6, 2022
* 💄 fix: Added CAUTION admonition shortcode (closes unicef#66)
* 💄 fix: Added IMPORTANT admonition shortcode (closes unicef#64)
* 💄 fix: Added admonition icons and updated docs

* Revert IDE changes to French localized file.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

* Remove extraneous changes to index page

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

Co-authored-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>
jwflory added a commit to unicef/inventory that referenced this pull request May 9, 2022
This incorporates several of the new contributions made by Outreachy
applicants during the community contribution period of the internship:

* @Neha9849
* @mmldco
* @Yavnikaa
* @BeeBombshell
* @AbihaFatima

The following changes are now incorporated into O.S. Inventory site:

* unicef/inventory-hugo-theme#56 Added embed-pdf shortcode
* unicef/inventory-hugo-theme#68 Add condition to only show "RA Section" when there's content available
* unicef/inventory-hugo-theme#73 Make Table of Contents more appealing and responsive
* unicef/inventory-hugo-theme#72 Improved styling of highlight code blocks
* unicef/inventory-hugo-theme#83 Added shortcodes for CAUTION and IMPORTANT admonition
* unicef/inventory-hugo-theme#94 Highlight the background color of buttons while hovering

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>
jwflory added a commit to unicef/inventory that referenced this pull request May 9, 2022
This incorporates several of the new contributions made by Outreachy
applicants during the community contribution period of the internship:

* @Neha9849
* @mmldco
* @Yavnikaa
* @BeeBombshell
* @AbihaFatima

The following changes are now incorporated into O.S. Inventory site:

* unicef/inventory-hugo-theme#56 Added embed-pdf shortcode
* unicef/inventory-hugo-theme#68 Add condition to only show "RA Section" when there's content available
* unicef/inventory-hugo-theme#73 Make Table of Contents more appealing and responsive
* unicef/inventory-hugo-theme#72 Improved styling of highlight code blocks
* unicef/inventory-hugo-theme#83 Added shortcodes for CAUTION and IMPORTANT admonition
* unicef/inventory-hugo-theme#94 Highlight the background color of buttons while hovering

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>
Neha9849 added a commit to Neha9849/inventory-hugo-theme that referenced this pull request Jun 1, 2022
fixing the pdf view

minor fix

Update exampleSite/content/installation/elements/_index.en.md

Co-authored-by: Justin W. Flory <jflory7@gmail.com>

:lipstick: layouts(navigation): Use consistent color on all pages (unicef#58)

This commit fixes a bug where the UNICEF Blue was hard-coded into the
navigation bar, and changes that hard-coded value to use the primary
color set by the site maintainer in the Hugo config file (`params.`
`primary_color`).

Additionally, I changed the color for the translations options to use a
white color, since it is hard to read when the primary color is a darker
color.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

:new: :lipstick: layouts: Add dpg-report layout (see unicef/coach#1) (unicef#44)

This commit creates a new custom layout for DPG report cards in the
UNICEF Inventory theme. DPG report cards are at-a-glance views of a
Venture Fund company's progress in meeting the DPG Standard.

More context about this change is in unicef/coach#1. This commit should
be merged once the idea is validated and the early prototyping phase is
complete.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

:new: :lipstick: layouts(shortcodes): Create table layout (unicef#70)

Shortcode for a table used in unicef/inventory#125.

:new: :sparkles: layouts(shortcodes): Add embed-pdf shortcode (unicef#56)

I have added a demo of this shortcode on the `installation/elements` page. For using this Shortcode, we have to pass the name of the pdf into the shortcode as shown in the demo. The pdfs should be stored in the `static/pdfs` folder.

Fixes unicef#33.

Co-authored-by: Justin W. Flory <jflory@unicef.org>

:bug: layouts(default): Add condition to show "RA Section" when content is available (unicef#68)

Fixes unicef#30.

* Add hugo condition to only show "RA Section" when there's content available
* Modify hugo conditions to check for available content before displaying the ra section
* Fix duplication of 'RA' section bug introduce by commit e4a8438
* Refactor hugo condition reposible for fixing the bugs in both issue unicef#30 and commit e4a8438
* Undo code refactoring introduced by commit 3f534dd

Co-authored-by: Zab <zab@marmalade.co.ke>

:lipstick: assets(css): Make Table of Contents more appealing and responsive  (unicef#73)

* Complete the stated task
* Make table of contents more appealing and responsive
* Update template title
* Update layouts/partials/head.html

Commit emoji: https://gitmoji.dev/

Co-authored-by: Justin W. Flory <jflory@unicef.org>

🐛 assets(css): Fix styling of highlight code blocks (unicef#72)

* 🐛 fix: Improved styling of highlight code blocks
* Reduced whitespace between codelines using css
* 📝 docs: Added comment for CSS changes

:recycle: layouts(dpg-report): Reuse download-pdf partial (unicef#74)

The PDF download button logic was moved into a partial after this layout
was created. This refactors to use the partial and maintain less code.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

:bug: :wrench: config: Removed Duplicate Home Link in Footer (unicef#80)

Fixes unicef#57.

In Footer partial, we have this:

```html
 <li><a class="nav-link text-white" href="{{ site.BaseURL | relLangURL }}">HOME</a></li>
        {{ range site.Menus.main }}
          {{if ne .Name "pages"}}
            <li class="nav-item">
              <a class="nav-link text-white text-uppercase" href="{{ .URL | absLangURL }}">{{ .Name }}</a>
            </li>
          {{ end }}
        {{ end }}
```

In all other upstreams, we don't have Home in the Menu array but we do have it in the exampleSite. This is what causes the duplication in exampleSite. So, I have removed it from the config file of the example site.

:bug: :memo: README: Fix link for example site config (unicef#82)

An example configuration used to be bundled at the top of the repo, but
now it is included as part of the example site used in building this
theme. This commit fixes the broken link in the README.

Closes unicef#79.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

:bug: :wrench: ci: Fix GH Pages push with string comparison operator

This commit changes the string comparison operator for the git user name
in the deploy script used in continuous integration. Currently the check
is checking if the string is not empty, then it overrides what was set.
We actually wanted the inverse.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

:new: :memo: .github: Add contributing guidelines (unicef#86)

* 🆕 📝 .github: Add contributing guidelines

This commit adds new contributing guidelines for the UNICEF Inventory
theme. It includes four main topics:

1. Contribution process (a.k.a. governance)
2. Conventions & courtesies
3. Structure & components
4. How to create a developer environment

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

* Address @Idadelveloper feedback in PR unicef#86; s/tickets/issues/

This commit makes a few changes, mostly coming from Ida's feedback in
Pull Request unicef#86:

1. Add a note about creating a git feature branch after being assigned
   an issue.
2. Add a note to tag an issue number in the commit message(s) of a Pull
   Request.
3. Change all mentions of "ticket" to "issue" to be more clear.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

💄 Admonitions: Standardize appearance and add new shortcodes (unicef#83)

* 💄 fix: Added CAUTION admonition shortcode (closes unicef#66)
* 💄 fix: Added IMPORTANT admonition shortcode (closes unicef#64)
* 💄 fix: Added admonition icons and updated docs

* Revert IDE changes to French localized file.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

* Remove extraneous changes to index page

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

Co-authored-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

:lipstick: css: Highlight buttons on hovering (unicef#94)

Fixes unicef#90.

Type of Change:

- Code
- User Interface

📝 docs: Added table shortcode in elements page (unicef#96)

Fixes unicef#71.

This PR adds table shortcodes to the existing tables along with the documentation to the elements page.

added inventory layouts

 Added layouts of inventory
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: new change Adds new capabilities or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support a new AsciiDoc admonition block: IMPORTANT
3 participants