diff --git a/_toc.yml b/_toc.yml index b7bed6405..ad76a2627 100644 --- a/_toc.yml +++ b/_toc.yml @@ -159,6 +159,7 @@ parts: - caption: About chapters: - file: content/About/about_1.md + - file: content/contribution_plan.md - caption: Glossary chapters: - file: content/Glossary/en_glossary_1.md diff --git a/content/About/about_1.md b/content/About/about_1.md index 5ed5d913d..319349de2 100644 --- a/content/About/about_1.md +++ b/content/About/about_1.md @@ -1,4 +1,4 @@ -# **Welcome at the GIS Training Resource Center!** +# About Whether being a beginner or already having some experiences, working with QGIS can be difficult. Our goal is to provide a comprehensive platform containing the essential skills and resources for the use in humanitarian aid without having to google for hours. 🔎 @@ -7,7 +7,7 @@ This QGIS training is made by people who believe GIS can help humanitarians to s ### Our Mission: We share the commitment to humanitarian aid. Through this website, our goal is to offer a unified, accessible and comprehensive resource, equipping individuals and organizations with the knowledge and tools necessary for working with QGIS. -This Ressource Center is also the resource for guided training modules. +This Resource Center is also the resource for guided training modules. ## About Us: diff --git a/content/Glossary/en_glossary_1.md b/content/Glossary/en_glossary_1.md index 1166aa56f..6a1bb1626 100644 --- a/content/Glossary/en_glossary_1.md +++ b/content/Glossary/en_glossary_1.md @@ -1,5 +1,7 @@ -# Glossary (Draft) +# Glossary +Draft + | Term| Description | | -------- | --- | |Analysis Map | Analyses data in respect to their geographic location.| diff --git a/content/Module_1/en_qgis_start.md b/content/Module_1/en_qgis_start.md index 7fbacfe84..d093f638c 100644 --- a/content/Module_1/en_qgis_start.md +++ b/content/Module_1/en_qgis_start.md @@ -118,7 +118,9 @@ A QGIS project file has the format ending `.qgz` The interface of QGIS is at first glance quite complex. However, once you know all the components you will be able to orientate yourself quickly. Here you can find a description of all components of the interface. ```{tip} + When you hover with your mouse cursor over icons, text will appear which explains the function of the button. + ``` ```{figure} /fig/en_QGIS_GUI.png @@ -309,7 +311,10 @@ To open the Toolbox in QGIS click on the gearwheel button. Or click on `Processi You can use the search bar to find specific tools. -```{tip} There are cases when you want to do something in QGIS but do not know the exact tool. Sometimes it's worth just looking for what you think the name of the tool might be. +```{tip} + +There are cases when you want to do something in QGIS but do not know the exact tool. Sometimes it's worth just looking for what you think the name of the tool might be. + ``` @@ -340,7 +345,9 @@ In QGIS, the geodata you work with is __not__ saved in your QGIS project file. I Good data organisation with a fixed and well-thought-out folder structure prevents such problems. ```{Warning} + Always organize your data! Check out the Wiki article on [Standard Folder Structure](/content/Wiki/en_qgis_projects_folder_structure_wiki.md) for more info. + ``` diff --git a/content/Module_1/en_qgis_theory.md b/content/Module_1/en_qgis_theory.md index d4ee21123..3d2758380 100644 --- a/content/Module_1/en_qgis_theory.md +++ b/content/Module_1/en_qgis_theory.md @@ -337,5 +337,3 @@ Example Map: UNHCR Iraq Population Profile - Breakdown Overview - Syrian Refugee ``` - - diff --git a/content/Wiki/en_licensing_data.md b/content/Wiki/en_licensing_data.md index 1ac80f2e6..fdc816754 100644 --- a/content/Wiki/en_licensing_data.md +++ b/content/Wiki/en_licensing_data.md @@ -1,4 +1,4 @@ -(ChatGPT) +# Data Licensing Licensing and working with licensed datasets in GIS involves careful adherence to legal, ethical, and practical considerations. Here are some best practices: diff --git a/content/contribution_plan.md b/content/contribution_plan.md new file mode 100644 index 000000000..3b3b0f777 --- /dev/null +++ b/content/contribution_plan.md @@ -0,0 +1,221 @@ +# Contribution Plan for the IFRC GIS Training Platform + +## Introduction + +Thank you for your interest in contributing to the IFRC GIS Training Resource Center. +This page outline the contribution process and guideline for collaborating with the GIS Training Resource Center. It provides details for contributions and related best practices. Whether you're looking to add new content, contribute to existing material, or collaborate on enhancing the platform overall as a partner, this guide will help to understand the necessary steps. + +:::{admonition} TEST +:class: note +::: + +## Collaborations + +### Content + +Collaborators are encourages to propose new topics or content relevant to the GIS Training Resource Center. These topics should align with the training objectives for Anticipatory Action (AA), Information Management and focus on basic GIS operations. If you have a topic in mind, please send a brief introduction and key points to `gis-training-platform@heigit.org` to initiate collaboration. + +To help us understand and evaluate your proposal, kindly consider the following three guiding questions: + +1. __What level of GIS expertise is required for the proposed content?__ +2. __What is the main learning objective or added value of the proposed content?__ +3. __Will you be adding the content to the training platform yourself (in markdown), or would you require support?__ + +We will review and assess each idea on a case-by-case basis. + +### Interested in becoming a Partner or Supporter of the Training Resource Platform? + +The GIS Training Working Group behind the IFRC GIS Training Resource Center was established by the British, German, and Netherlands Red Cross Societies, with technical support from the Heidelberg Institute for Geoinformation Technology (HeiGIT). + +In addition to content contributions, this consortium welcomes new partners from the Red Cross and Red Crescent Movement. We also encourage contributions in the form on in-kind or financial support to help further develop and drive continuous improvement of the platform. + +## Content Contribution Guidelines + +### Your contribution + +- __Markdown MyST and Jupyter Book:__ In addition to CommonMark Markdown, Jupyter Book also supports a more fully-featured version of Markdown called __MyST Markdown__. This is a superset of CommonMark that includes syntactic pieces that are useful for publishing computational narratives. For more information about MyST Markdown, see [MyST Markdown overview].(https://jupyterbook.org/en/stable/content/myst.html). +- __Changes on the Dev-Branch:__ + - All changes must be pushed to the `dev` branch. These changes will be reviewed by HeiGIT and/or RC before a pull request is merged. + - Currently, only HeiGIT or RC are authorized to create pull requests and contributors can request reviews from HeiGIT and/or RC via GitHub. +- __New Content:__ + - If you have ideas for new content (either as new sections in existing modules or new standalone modules), send us an email or submit an issue in github using the appropriate tags. A proposal may also include a markdown page or suggested structure. + - New content proposals will undergo review, and contributors are encouraged to actively engage with reviewers via GitHub issues. For deeper discussions about content or collaborations, HeiGIT/RC are happy to schedule video calls. +- __External Data Submission:__ + - If you need to send data or other materials, you can email them to `gis-training-platform@heigit.org` to be uploaded to the Nexus Data Repository. + +### Licences + +- __Copyright and Data Sources:__ Always provide clear citations for any external material, including articles, books, and web content. For articles and books, include the full citation with DOI. For webpages, include the source URL (external links must be maintained) +- All content within the platform will be published under the __[CC 4.0 BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/)__ license + +### Ideal Structure for New Content + +The structure of new modules/chapters should ideally include: + +1. __Theory:__ Introduction to key concepts. +2. __Practical Examples:__ Demonstrate how to apply concepts in Anticipatory Action, Information Management, and QGIS. +3. __Exercises:__ Hands-on practice with follow-along exercises. +4. __Synthesis:__ A more complex exercise or example that synthesizes the module content +5. __Self-Assessment Questions:__ To test comprehension of the module's main concepts + +### Types of Content + +- __Theory:__ Explanation of concepts. +- __Real World Examples:__ Include practical examples that are relevant to the GIS field (preferably related to IM, AA, or humanitarian work in general). +- __Exercises:__ Follow-along or self-guided exercises to reinforce learning. +- __Discussion Questions:__ Promote interaction and connection to real-world scenarios. +- __Wiki:__ Brief articles that provide explanations or instructions related to the platform. +- __Figures:__ Pictures or figures to illustrate theoretical concepts, real world examples or show screenshots +- __Videos:__ The platform uses short videos without commentary to show how to perform certain steps (e.g., edit the attribute table, import layers, or set the symbology of a layer) + +```{note} +Keep in mind that there are many detailed GIS resources as well as official documentation. Explain the necessary theory for trainees to perform the tasks. You can also refer to external resources. +``` + +### Exercise Guidelines + +- __Instructions:__ Provide step-by-step instructions. +- __Facilitator Notes:__ Include notes for facilitators on how to guide the exercise. +- __Data:__ Always provide a link to the dataset(s) used in the exercise. Ensure the dataset is cleaned of personal data and errors unless data cleaning is part of the exercise. + +:::{note} +Contributors are encouraged to upload videos for step-by-step guides where useful. +::: + +## File naming and Formatting Guidelines + +Follow these guidelines for naming files and structuring directories: + +- __Naming:__ Choose descriptive names. Ensure that exercises are numbered correctly (e.g. `module_#_ex#_title`). The exercise number should be the next available number +- __Folder Structure:__ Ensure that exercise data follows the [correct folder structure](https://giscience.github.io/gis-training-resource-center/content/Wiki/en_qgis_projects_folder_structure_wiki.html#standard-folder-structure) and is zipped correctly (avoid excessive folder nesting as this can lead to problems when unzipping) +- __Language and QGIS Version:__ Always include the QGIS version and language in the file names. +- __Pictures:__ All pictures and figures have to be stored in the folder `/fig/`. + - General common pictures just have to have a sort and informative title. + - Picture name example: HeiGIT_logo_compact.svg + - In the case of a screenshot of QGIS or another program, additional rules apply. First, the abbreviation of the used language has to be included (e.g. en). Second, the QGIS version (e.g. 3.28). + - Screenshots name example: en_3.29_clip_tool.png + - In instances of pictures of the OSM or satellite imagery, one has to include the year and place. + - Picture of maps or satellite imagrey example: OSM_Heidelberg_2023.png + +Follow these guidelines when creating and formatting content: + +- __Spelling:__ Use British English spelling. +- __Headings:__ + - `# Title` for the main titles of markdown pages + - `## Title` for sections + - `### Title` for subsections + - Avoid headings deeper than H3 (`### Title`). Use bold, underlining or put it into cards to achieve a similar effect. +- __Links:__ + - In Markdown, you can embed links into text by using `[text/name](link)` +- __Figures and Images:__ + - Images and videos are saved to the `/fig/`-folder. + - Use the figure directive for images: + ``` + :::{figure} /fig/example.png + --- + name: example_figure + width: 750 px + align: center/left/right + --- + Descriptive Caption including source of the image + ::: + ``` + - `name` must indicate a unique descriptive name. You can refer to figure in text by using: + ``` + {numref}`name` + ``` + - This does not work in pages that are not included in the `TOC.yml`-file + - ``width` specifies the pixel width. The maximum amount of pixels for width is 750 px. Alternatively, you can use `height`. Be careful to set high values as this will distort the image once it reaches the 750 px width cap. + - align specifies where the image should be rendered on the markdown page. E.g., `align: left` can be used to align the image to the left part of the page and leave space for text on the right. + - The caption should describe what is seen on the figure in the context of the section. The image sources must be specified as precisely as possible. + - It is possible to embed icons into the text by using `![](/fig/FILENAME)`. Make sure the icon height does not exceed 30 pixels. +- __Admonitions:__ + - Use admonitions such as note, caution, tip, tldr for additional notes such as + ``` + :::{admonition} TITLE + :class: tip, caution, note, tldr, note + CONTENT + ::: + ``` +- __Dropdowns:__ For optional content (e.g. videos or supplementary information), use dropdowns: + ``` + :::{dropdowns} TITLE + CONTENT + ::: + ``` +- __Cards:__ Use the card directives to highlight content in a "card": +``` +:::{card} +HEADER +^^^ +CONTENT +::: +``` +- __Grids:__ To create several columns to display content or images side by side, you can create grids: +``` +::::{grid} 2 + +:::{card} + +::: + +:::{card} + +::: + +:::: +``` + +- __Margins:__ Sometimes, it can be useful to put hints or additional information into the margin to the right. This can be achieved with the following directive: + ``` + ::::{margin} + CONTENT (can include other directives) + :::: + ``` + +:::::{admonition} Nesting directives +:class: tip +It is possible to nest directives such as figures inside of cards or admonitions. Simply use more colons around directives that enclose other such as: + +``` + +::::{card} +HEADER +^^^ +CONTENT + +:::{figure} /fig/figure.png +--- +name: +width: +align: +--- +CAPTION +::: + +:::: + +``` + +::::: + + +- __Embedding Videos:__ Videos need to be embedded using HTML-code: + ``` + + ``` + - copy the code and enter the name of the video file you want to embed. + +- __Text formatting standards:__ + - When describing a process, use numbers. For example: + ``` + 1. Right-click on "ML1_IPC_Index" layer -> `Attribute Table`-> click on [`Field Calculator`](https://giscience.github.io/gis-training-resource-center/content/Wiki/en_qgis_table_functions_wiki.html#calculate-field) ![](/fig/mActionCalculateField.png) to open the field calculator + 2. Check `Create new field` + 3. `Output field name`: Name the new column “Trigger_activation” + 4. `Result field type`: Text (string) + ``` + - __All clickable surface has to be written as code snippets e.g. `Attribute Table`__ + - If a special icon is used in QGIS, place it next to the code snippets e.g `Field Calculator` ![](/fig/icon_scratch_layer.png). + - If an option needs to be selected, write the click surface name in code snippet and the option as normal text e.g. `Result field type`: Text (string) + - If something like a file name has to be named in a certain way use quotation marks e.g. `Output field name`: Name the new column “Trigger_activation” + - Where it makes sense add the link to the relevant wiki video when the participants should use a tool or a functionality that is not in detail described in your current step-by-step guide either by linking the tool name e.g. [drag and drop](https://giscience.github.io/gis-training-resource-center/content/Wiki/en_qgis_import_geodata_wiki.html#open-vector-data-via-drag-and-drop) or by using something like ([Wiki basemap](https://giscience.github.io/gis-training-resource-center/content/Wiki/en_qgis_basemaps_wiki.html)) \ No newline at end of file diff --git a/content/intro.md b/content/intro.md index dae264f92..bf848a35a 100644 --- a/content/intro.md +++ b/content/intro.md @@ -9,24 +9,27 @@ ___ # Welcome to the IFRC Network GIS Training Platform -::::{grid} 1 :::{card} -# Teach GIS for Humanitarian Work - -The One-Stop-Shop for teaching Geoinformation System (GIS) skills for the work in the Red Cross Red Cresent Network +:class-card: sd-text-justify sd-border-1 +__Teach GIS for Humanitarian Work__ +^^^ +The One-Stop-Shop for teaching Geoinformation System (GIS) skills for the work in the Red Cross Red Crescent Network ::: -:::: + ::::{grid} 2 :::{card} -__[Start Teaching](/content/Trainers_corner/en_TOT_intro.md)__ ➡️ +:link: https://giscience.github.io/gis-training-resource-center/content/Trainers_corner/en_TOT_intro.html + +__[Start Teaching](https://giscience.github.io/gis-training-resource-center/content/Trainers_corner/en_TOT_intro.html)__ ➡️ ::: :::{card} +:link: https://giscience.github.io/gis-training-resource-center/content/Module_1/en_module_1_overview.html -__[Start Learning](/content/Modul_1/en_qgis_theorie.md)__ ➡️ +__[Start Learning](https://giscience.github.io/gis-training-resource-center/content/Module_1/en_module_1_overview.html)__ ➡️ ::: @@ -54,7 +57,7 @@ ___ ## What's Inside -Trainers for QGIS are the principal audience of the IFRC Network GIS Training Platform. Here you can find training materials for teaching QGIS specific for the work in the Red Cross Red Cresent network for total beginners up to an intermediate level. +Trainers for QGIS are the principal audience of the IFRC Network GIS Training Platform. Here you can find training materials for teaching QGIS specific for the work in the Red Cross Red Crescent network for total beginners up to an intermediate level. 🙌 The training material is centred around the extensive use of practical follow-along exercises and hands-on training. @@ -67,7 +70,7 @@ The primary objective is to empower individuals across various roles within the The QGIS skills offered on this platform span basic, intermediate, and advanced proficiency levels, with each level comprising three dedicated modules. :::{dropdown} Basic Skills -| Modul 1 - Introduction GIS ✨| Modul 2 - Working with Geodata 🌍 | Modul 3 - Basic GIS operations 📍 | +| Modul 1e - Introduction GIS ✨| Module 2 - Working with Geodata 🌍 | Module 3 - Basic GIS operations 📍 | |-------------------------------|------------------------------------|-----------------------------------| | Installation QGIS | Layer Concept in GIS | Digital data editing and creation | | Paper maps and cartography, digital maps distinction | Data Import |Feature attribute selection and editing | @@ -80,13 +83,13 @@ The QGIS skills offered on this platform span basic, intermediate, and advanced | |Data Sources| | :::: -:::{dropdown} Intermidate Skills +:::{dropdown} Intermediate Skills -|Modul 4 - Representation 🗺️ | Modul 5 - Intermidate GIS Operations 🌐| Modul 6 - Data analysis with QGIS 📊 | +|Module 4 - Representation 🗺️ | Module 5 - Intermediate GIS Operations 🌐| Module 6 - Data analysis with QGIS 📊 | |-----------------------|---------------------|-------------------------------------| -|Visualisation |Geoprocessing: Buffer|| -|Graphical variables|Geoprocessing: Clip |Data access | -|Styling in QGIS |Geoprocessing: Dissolve |QGIS Plugins Example: QuickOSM | +|Visualisation | Geoprocessing: Buffer|| +|Graphical variables| Geoprocessing: Clip | Data access | +|Styling in QGIS | Geoprocessing: Dissolve | QGIS Plugins Example: QuickOSM | |Symbology and Colors |Clip by Mask|Remote Sensing/ Raster Data Intro| |Export/Import styles|Clip by Extent ||| |Print layout|Non-spatial queries || @@ -95,7 +98,7 @@ The QGIS skills offered on this platform span basic, intermediate, and advanced ::: :::{dropdown} Advanced Skills -|Modul 7 - Automatisation 💻| Modul 8 - Remote Sensing and Raster data 🛰️ |Modul 9 - Accessbility 🚑| +|Module 7 - Automatisation 💻| Module 8 - Remote Sensing and Raster data 🛰️ |Module 9 - Accessibility 🚑| |-----------------------|---------------------|-------------------------------------| |Automation intro|Zonal Statistics|Accessibility analyses| ||Extraction of raster values|Spatial analysis | @@ -108,16 +111,17 @@ The QGIS skills offered on this platform span basic, intermediate, and advanced ::::{grid} 2 -:::{card} __[Trainer's](/content/Trainers_corner/en_TOT_intro.md)__ +:::{card} __[Trainers](/content/Trainers_corner/en_TOT_intro.md)__ There is a dedicated [section for trainers](/content/Trainers_corner/en_how_to_training.md) who want to use the platform. The most important component is the training plans. These give you an orientation on when to use what in your training cycle. Nevertheless, every component of the training material is designed to be utilized independently. In addition to the training plans, you'll discover a wealth of resources, ranging from best practices for training to innovative methods for teaching GIS. + ::: -:::{card} __[Trainee's](/content/Modul_1/en_qgis_theorie.md)__ +:::{card} __[Trainees](https://giscience.github.io/gis-training-resource-center/content/Module_1/en_module_1_overview.html)__ Your trainers will be your guides for this platform. If you have any questions, feel free to ask them any questions about this training platform. -This is not a self-learning platform. If you want to learn QGIS, it is always better to participate in a course and learn from an experienced trainer. However, you are welcome to use this platform for homing your QGIS skills, just beaware that selflearning ist not the objective of the platform. +This is not a self-learning platform. If you want to learn QGIS, it is always better to participate in a course and learn from an experienced trainer. However, you are welcome to use this platform for homing your QGIS skills, just be aware that self-learning ist not the objective of the platform. ::: :::: ___ @@ -133,10 +137,13 @@ ___ ## Contact -```{admonition} Contact the IFRC GIS Training Plattform Team -You have questions, feedback or comments on the platform and the content. We are allways happy to hear from you. You can contact us via email __gis-training-platform@heigit.org__ +```{admonition} Contact the IFRC GIS Training Platform Team +You have questions, feedback or comments on the platform and the content. We are always happy to hear from you. You can contact us via email under __gis-training-platform@heigit.org__ ``` +## Contributing + +We warmly welcome everyone to contribute and collaborate in advancing the IFRC GIS Training Platform, fostering shared knowledge and growth. Before contributing, please read through the [Contribution Plan](https://giscience.github.io/gis-training-resource-center/content/contribution_plan.html) ## Join the Community