Global Innovation Toolkit

Welcome to the Global Innovation Toolkit Initiative. This guide provides instructions on setting up and customizing your toolkit site.

Table of Contents

• Introduction
• Toolkit Webpage Sample
• Folder Structure
• Tutorials
• Customizing Configuration
• Submitting Requests
• Set Up the Toolkit Micro-site Locally
• License

Introduction

The toolkit site uses Jekyll, a static site generator. Follow the steps below to get started.

Sample toolkits

See samples of the toolkits created from this template for an idea of the minimal configuration options available.

• National Innovation Ecosystems (NIE) toolkit
• Digital Financial Inclusion (DFI)
• UNDP Signature Solution Toolkit

Folder Structure

Recommended structure for your toolkit project:

├── index.md # Home page
├── _data/
│ ├── site_info.yml # Customize site configuration
├── _layouts/
│ ├── default.html # Default layout template
content
│ ├── getting-started/
│ ├── index.md # Getting started side menu config
│ │ ├── values.md # Example page under Getting Started
│ ├── Second Topic/
├── index.md # Side menu config
│ │ ├── values.md # Example page new sub-topic
├── public/
│ ├── imgs/ # Image files
├── _config.yml # Jekyll configuration file
├── README.md # Instructions for users

Tutorials

Explore the Tutorials section for step-by-step guides:

• Create a GitHub Account
• Create a Toolkit Repository
• Create a Branch on GitHub
• Create a Folder or File on GitHub
• Manage merge request
• Write Your Content
• Publish Your Changes to Live Website
• Customizing the Contributors Page

Customizing Configuration

Edit _data/site_info.yml and _data/site_styles.yml for site configuration. Update baseurl in _config.yml. For navigation/menu customization, update nav.html and sidebar.html.

Tagging System

The toolkit has a tagging system, allowing you to categorize factsheets based on five key criteria: 'Signature Solutions', 'Enablers', 'RBLAC Priorities', 'TAGS' and 'SDG'.

How to Use Tags

To utilize this tagging feature, you can include the following configuration in your toolkit:

# CONFIGURATION BELOW IS ONLY NEEDED IF YOU WANT TO USE TAGS AND CATEGORY IN THE TOOLKIT

signature_solutions: [ Poverty and Inequality, Governance ]
enablers: [ Digitalisation ]
rblac_priorities: [ Pillar 1 Inclusive and Sustainable Growth ]
sdg: [ 1 No Poverty ]
tags: [ Policy, Governance ]

These tags are optional. If no tags are used within your toolkit, the tagging and filter-by-tag features will not be present. However, if any of the tags are used, the corresponding filters will be dynamically added to your toolkit.

Once you add any of these tags to your factsheets, the corresponding sidebar and dropdown filters for these tags will automatically appear. You can preview a sample of this feature in the training toolkit.

That's it! You're ready to create, customize, and deploy your Toolkit site. Have fun documenting and sharing your content!

Submitting Requests

Have a question or facing an issue? We're here to help! Follow the steps below to submit a request using our issue template.

Types of Requests

Bug Report

Encountered a bug in the toolkit? Help us improve by reporting it. Provide details on what happened, expected behavior, and any error messages.

Toolkit Creation Assistance

Need to start a new project that requires a toolkit? Let us know, and we'll provide the support you need.

Custom Domain Configuration

Looking to set up a custom domain for your toolkit? Submit a request, and we'll guide you through the configuration process.

Usage Monitor Configuration

Interested in monitoring usage and performance? Reach out for assistance in configuring usage monitors for your toolkit.

How to Submit a Request

1. Click on the Issues tab at the top of the repository.
2. Select "New Issue."
3. Choose the appropriate issue template based on your request type.
4. Fill in the template with as much detail as possible.
5. Click "Submit New Issue" to open your request.

Our team will review your request and provide assistance as soon as possible. Thank you for contributing to the improvement of the UNDP Accelerator Labs Toolkit!

Set Up the Toolkit Micro-site Locally

Follow these steps to set up the UNDP Accelerator Labs Toolkit Micro-site locally on your computer for development and customization:

1. Clone the Repository:

   git clone https://github.com/UNDP-Accelerator-Labs/toolkit-micro-site-template.git

2. Navigate to the Repository:

   cd toolkit-micro-site-template

3. Install Dependencies: Ensure you have Ruby and Bundler installed on your computer. If not, you can install them following these instructions. Then, install the required dependencies by running:

   bundle install

4. Run the Local Server: Start the local development server by running the following command:

   bundle exec jekyll serve 

   This command will build the site and start a local server. You'll see an output with a URL like http://127.0.0.1:4000/. Open this URL in your web browser to view your locally hosted toolkit micro-site.

License

This project is licensed under the Creative Commons Attribution 4.0 International License.

You can view the full license text here.