#ASKtraining training plan

With the #ASKnet training plan you can compile and plan your individual training. You can choose from the different training modules and freely organize the schedule for your training. The training plan automatically creates a schedule with recommended breaks, which are then individually adjusted.

Afterwards, the training plan shows which resources are needed, how high the material costs are, how high the recommended number of participants should be and how many trainers are needed.

You can also add helpful attachments to your training plan, such as a timetable, material checklists, and more. Your individual training plan is ready, which you can then download as a PDF package to share or print out.

--===<({ Demo })>===--

Table of Contents

• #ASKtraining training plan
  • --===<({ Demo })>===--
  • Table of Contents
  • Documentation
  • Developer
    • Folder structure
    • Editor Settings
    • Run local
    • Requirements
    • Setting up and running locally
    • Styling
      • Compiling CSS from Sass
      • Other CSS libraries
    • Contributing
  • Partners and Funder
  • License Note

Documentation

All information on how to use the training plan, install it or create additional modules can be found in the documentation.

Developer

Here you can see the concept paper

Folder structure

.
├── 404.html
├── assets                                      # JS, CSS, fonts, and image assets
│   ├── css                                     # Autogenerated CSS. DO NOT EDIT MANUALLY
│   ├── fonts                                   # font styles
│   ├── img                                     # image assets
│   │   ├── modules                             # module images
│   └── js                                      # JavaScript files - edit JS files from here
├── _config.yml                                 # Jekyll config
├── _data
├── docker-compose.yml                          # docker config
├── Gemfile                                     # external modules/packages
├── Gemfile.lock
├── _includes                                   # Jekyll [Includes directory](https://jekyllrb.com/docs/includes/)
├── index.html
├── _layouts                                    # Jekyll [Layouts directory](https://jekyllrb.com/docs/layouts/)
│   └── trainingsplan.html                      # Training plan layout
├── LICENSE.md
├── _modules                                    # Training modules
├── README.md
├── _resources                                  # Training resources
├── _sass                                       # SASS files. Do your styling here
├── _site                                       # Autogenerated static site. DO NOT EDIT MANUALLY
├── training.html
└── training.yml

Editor Settings

The settings for VSCode and VSCodium can be found in the .vscode directory.

VSCode and VSCodium users will get a recommendation to install the Live Sass Compiler when they open the repository for the first time in their editor. The extension will use the editor settings to compile any SASS files that you edit.

Users of other editors will need to get an alternative SASS compiler and to adapt their settings to the ones in .vscode > settings.json to work on the SASS files. Check here for more info.

Run local

Requirements

• docker >~ v.20.10.3: Docker for running the app in a container
• docker-compose >~ v.1.27.4: Docker Compose for defining the docker configuration and running the app
• Internet connection

Setting up and running locally

To start the app initially:

• Open Gemfile and add the following (This is only a temporary adjustment for local instance development! DO NOT COMMIT TO MAIN BRANCH!)

gem "webrick"

• Start the app with

docker compose up

Go to your browser and type http://0.0.0.0:4000

To stop the app:

docker compose stop

To run the app in detached mode(run in the background):

docker compose up -d

After the initial start, you can start with the following command without an internet connection:

docker compose start

Docker Compose manual:

docker compose man
docker compose --help # same as docker compose man
# Use docker compose COMMAND --help to get additional information on a command e.g.
docker compose up --help # to get additional information on the `up` command

Styling

All styling changes are made in the Sass files in the _sass folder. The min.css and min.css.map files (target) will be compiled automaticly from the Sass files (source). You can find more information about the Sass syntax here.

Compiling CSS from Sass

Important: You need a Sass compiler for this! If you use VSCodium/VSCode as your IDE, you can use the plugin Live Sass Compiler .

The following settings in the plugin are recommended:

"liveSassCompile.settings.formats": [
    {
        "format": "compressed",
        "extensionName": ".min.css",
        "savePath": "assets/css/",
        "savePathReplacementPairs": null
    }
],

You can find the documentation for the Live Sass Compiler here including instructions for how to change the extension's settings.

Other CSS libraries

CSS libraries from other sources are saved directly in the /assets/css folder as *.min.css and *.min.css.map. To do this, please enter the version number of the library in the file name in the following format.

Example: bootstrap-5.3.2.min.css

The library must then be integrated either in a layout file in the /_layouts directory or in main.sass.

Contributing

Contributions are more than welcome! Please check out the contributing guide.

Partners and Funder

r0g Agency	ASKnet	BMZ
Official Website	Official Website	Official Website

License Note

All content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

The Configurator Software is licensed under a GPLv3 License (see LICENSE.md File)

First prototype developed by NanoLogika

Software used:

• Bootstrap CSS, JavaScript
• Jekyll Theme and other external resources via Gemfile
• Fonts: Font-Awesome, Poppins, Noto-Sans, Josfin-Sans
• JavaScript Libraries: MIT Licensed see JS files (header)