restructure around dpg standards #136

Neha9849 · 2022-07-06T16:40:58Z

No description provided.

jwflory

Just taking a quick pass here! Looking good so far, but I'll test it locally once the layout is pushed up in a new Pull Request for the theme. Some quick comments and notes below to help guide you as you are working through this.

content/dpg indicators/1/_index.en.adoc

content/cohorts/_index.en.adoc

content/dpg indicators/3/approaches.en.adoc

content/dpg indicators/8/Open Hardware/_index.en.adoc

content/open source resources and best practices/mentorship/_index.en.adoc

jwflory · 2022-07-21T22:30:21Z

@Neha9849 Could you please update this Pull Request with commits from the staging site?

As a note, I think we should sync the main branch of unicef/inventory-staging with the restucture branch of Neha9849/inventory. This will make it easier to do regular peer reviews on this draft Pull Request, while still deploying changes made in this PR in real-time to GitHub Pages.

There could also be a stretch project of improving our Continuous Integration pipeline so previews are built automatically without taking the extra steps we are taking here. Something to tuck away for after the restructure. 😀

jwflory · 2022-08-05T13:57:23Z

In today's sprint retrospective, let's see if we can get unicef/inventory-staging to mirror the restucture branch used for this Pull Request. This will make it easier to incorporate changes, and I also have some content changes I want to start pushing based on feedback from the user testing! 👀

Edit: Done!

This fix is useful for DPG indicators restructure (unicef/inventory#136 and #144). If there is no content in a particular DPG indicator then this change will show the description of that page there.

jwflory · 2022-08-05T20:25:37Z

Repasting from a review in unicef/inventory-hugo-theme#144:

@jwflory wrote…
With some sleuthing (see this comment), it is now clear that my problem reproducing is because the layout wasn't set on the index page of the DPG Indicators page. This is now done (commit 3cd9bec374b57798835d79c620de4c2ccae80d1e). We need to set the staging site to use the right layout on the index page of the Indicators, and the individual pages can continue to use the default single page layout.

REQUIRED ACTION: This does create a problem because the site home page will only show categories with an _index.en.adoc/md with type: docs in the front-matter. We need to amend the home page layout so it shows pages with type: docs and also type: dpg-standard. @Neha9849, this is the next place to jump in on the DPG Indicators layout work. Please raise this in a new Pull Request.

jwflory · 2022-08-19T00:51:43Z

Rebased on latest main branch changes.

jwflory · 2022-08-19T11:43:11Z

Rebased on latest main branch changes and solved a merge conflict with the config file.

jwflory · 2022-08-20T11:06:56Z

Rebased on latest main branch changes.

jwflory · 2022-09-16T18:22:47Z

Note to self, this pull request needs to have a hard reset on unicef/inventory-staging:main to reflect the changes that @Neha9849 made for the live demo. Once the branch is reset, I will rebase this on unicef/inventory:main and confirm alias redirects are in place before merging.

This commit represents the sum changes for migrating the UNICEF Open Source Inventory to a new support structure modeled around the Digital Public Good Standard. Based on user testing research, the interface is made to be more useful for a project or Venture Fund start-up company aiming to achieve compliance with the Digital Public Good Standard. Redirects with page aliases are in place so all URL addresses from the old organizational model will redirect to the correct place. Closes unicef/inventory-hugo-theme#126. === :memo: Change DPG Indicators page type to dpg-standard This adopts the expected layout for the DPG Indicators, with a mini profile for each indicator. Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

This changes the user experience to make the user more aware that by visiting another UNICEF Toolkit, they will go to a different website. This addresses feedback from user research testing that found the "Toolkits" navbar option to be confusing, since the website and content changed but the general UI/UX remains the same. This change makes the redirect more obvious. It leverages the page redirect used previously in the Data Transparency & Ethics category in the Open Source Inventory. Closes unicef/inventory-hugo-theme#156.

jwflory · 2022-09-17T01:59:59Z

Rebased on latest main.

This commit shows the "team" template type on the index page of the site. The use case for this change is so that the total cohorts view still appears when navigating to `/inventory/cohorts/` and it also appears as its own category on the site homepage alongside other topics. This contributes to unblocking unicef/inventory#136. Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

This commit shows the "team" template type on the index page of the site. The use case for this change is so that the total cohorts view still appears when navigating to `/inventory/cohorts/` and it also appears as its own category on the site homepage alongside other topics. This contributes to unblocking unicef/inventory#136. 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>

Pulls the needed change from unicef/inventory-hugo-theme#174 and returns the original layout used for the all cohorts template view. Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

The need for the staging site will go away once this commit is merged to `main` branch of `unicef/inventory`. Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

A page redirect doesn't work on index pages. Instead, this page should be populated with basic information and the reader is encouraged to visit the SDG goals website for more information. Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

This commit includes several minor to moderate changes that prepares the DPG Standard indicator redesign to deploy to production: 1. Add `keywords` to post front-matter in order to better utilize the search bar function. 2. Remove `categories` front-matter from posts since this metadata is implicitly inherited by path. 3. Add and/or modify `tags` in many posts. 4. Fix aliases missing a starting `/` so they work as expected (previously, many aliases were incomplete and not working). 5. Minor formatting and syntax: Remove unnecessary quotemarks, change order of some front-matter, use alphabetical sorts, etc. 6. Reorganize some articles from one DPG Indicator to another. This happened mostly among DPG Indicators 2, 3, and 8. 7. Use Themify icon set for home page categories. Only set an `icon` front-matter for content categories that appear on the site index page. 8. Propose pages for deletion, using a `warning` admonition to give ample notice that a page may disappear from the site. 9. Utilize new site features in older content, like the page author and table of contents. Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

jwflory

Additional work was needed to finalize this change. Changes made in commit 547525c:

Add keywords to post front-matter in order to better utilize the search bar function.
Remove categories front-matter from posts since this metadata is implicitly inherited by path.
Add and/or modify tags in many posts.
Fix aliases missing a starting / so they work as expected (previously, many aliases were incomplete and not working)
Minor formatting and syntax: Remove unnecessary quotemarks, change order of some front-matter, use alphabetical sorts, etc.
Reorganize some articles from one DPG Indicator to another. This happened mostly among DPG Indicators 2, 3, and 8.
Use Themify icon set for home page categories. Only set an icon front-matter for content categories that appear on the site index page.
Propose pages for deletion, using a warning admonition to give ample notice that a page may disappear from the site.
Utilize new site features in older content, like the page author and table of contents.

jwflory · 2022-09-17T06:21:34Z

I believe this is now ready. Since this PR is a very large change, I want to make one final pass before approving. I'll review this one more time over the next week, and if only minor or no changes, I will approve and merge.

Some minor changes and improvements from the final review: * Change an AsciiDoc `:author:` tag to article `author:` front-matter * Remove wrapped quotation marks from more metadata fields * Add more tags and keywords to some articles * Add more aliases to previous paths for historical preservation (they were accidentally deleted during the reorganization) Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

jwflory

I made some final changes in commit 5e97993. This is now ready for merging! Pushing to production shortly. 🚀

jwflory assigned jwflory, Idadelveloper and Neha9849 Jul 11, 2022

jwflory added the T: new change Adds new capabilities or functionality label Jul 11, 2022

jwflory requested review from Idadelveloper and jwflory July 11, 2022 13:05

jwflory reviewed Jul 11, 2022

View reviewed changes

jwflory mentioned this pull request Aug 5, 2022

Sidebar navigation is clipped or goes off-screen with longer content unicef/inventory-hugo-theme#142

Closed

jwflory force-pushed the restucture branch from 2b9a832 to 0230736 Compare August 19, 2022 00:51

jwflory force-pushed the restucture branch from 0230736 to caea607 Compare August 19, 2022 11:42

jwflory force-pushed the restucture branch from caea607 to 5fa090b Compare August 20, 2022 11:06

jwflory mentioned this pull request Sep 16, 2022

[tracker] Outreachy Internship: Improve UI/UX of UNICEF Inventory and redesign site around the Digital Public Goods Standard #124

Closed

3 tasks

jwflory mentioned this pull request Sep 16, 2022

Update existing article: Overview of UNICEF Open Source Inventory #142

Open

Neha9849 added 2 commits September 16, 2022 21:37

jwflory force-pushed the restucture branch from 5fa090b to 8141650 Compare September 17, 2022 01:59

jwflory mentioned this pull request Sep 17, 2022

🐛 layouts(index): Show "team" type posts on index page unicef/inventory-hugo-theme#174

Merged

jwflory added 3 commits September 16, 2022 22:15

📝 cohorts: Add "UNICEF Venture Fund Cohorts" as site category

2032f83

Pulls the needed change from unicef/inventory-hugo-theme#174 and returns the original layout used for the all cohorts template view. Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

👷 ci: Drop staging naming convention

e5bf538

The need for the staging site will go away once this commit is merged to `main` branch of `unicef/inventory`. Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>

jwflory force-pushed the restucture branch from f2951c1 to 2d7e138 Compare September 17, 2022 02:39

jwflory reviewed Sep 17, 2022

View reviewed changes

jwflory mentioned this pull request Sep 17, 2022

As a prospective DPG applicant, I want fast and quick information about the DPG Standard so that I can understand what might be required of my project. unicef/inventory-hugo-theme#126

Closed

jwflory approved these changes Sep 18, 2022

View reviewed changes

jwflory merged commit da92f80 into unicef:main Sep 18, 2022

jwflory mentioned this pull request Sep 23, 2022

As an open source developer or product owner, I want to have better feedback on the search bar so that I can navigate using common shortcuts. unicef/inventory-hugo-theme#165

Open

jwflory mentioned this pull request Oct 6, 2022

As an open source developer or product owner, I want to find pages in search with keywords so I can better find the content I am looking for. unicef/inventory-hugo-theme#158

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

restructure around dpg standards #136

restructure around dpg standards #136

Neha9849 commented Jul 6, 2022

jwflory left a comment

jwflory commented Jul 21, 2022

jwflory commented Aug 5, 2022 •

edited

Loading

jwflory commented Aug 5, 2022

jwflory commented Aug 19, 2022

jwflory commented Aug 19, 2022

jwflory commented Aug 20, 2022

jwflory commented Sep 16, 2022

jwflory commented Sep 17, 2022

jwflory left a comment

jwflory commented Sep 17, 2022

jwflory left a comment

restructure around dpg standards #136

restructure around dpg standards #136

Conversation

Neha9849 commented Jul 6, 2022

jwflory left a comment

Choose a reason for hiding this comment

jwflory commented Jul 21, 2022

jwflory commented Aug 5, 2022 • edited Loading

jwflory commented Aug 5, 2022

jwflory commented Aug 19, 2022

jwflory commented Aug 19, 2022

jwflory commented Aug 20, 2022

jwflory commented Sep 16, 2022

jwflory commented Sep 17, 2022

jwflory left a comment

Choose a reason for hiding this comment

jwflory commented Sep 17, 2022

jwflory left a comment

Choose a reason for hiding this comment

jwflory commented Aug 5, 2022 •

edited

Loading