From cd56e3fe95b5b0a19edf6baf08a8dce2c2fe807f Mon Sep 17 00:00:00 2001 From: Onuralp SEZER Date: Thu, 29 Aug 2024 23:11:23 +0300 Subject: [PATCH] =?UTF-8?q?docs=20=F0=9F=93=9D=20inital=20index.md=20added?= =?UTF-8?q?=20and=20bo-oss=20and=20better=20mkdocs=20configs=20are=20added?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Onuralp SEZER --- README.md | 4 +- docs/index.md | 13 +++++++ docs/installing-opensuse.md | 3 +- mkdocs.yml | 77 +++++++++++++++++++++++++++++-------- 4 files changed, 78 insertions(+), 19 deletions(-) create mode 100644 docs/index.md diff --git a/README.md b/README.md index 95cbb6c..03c059c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The developers of this content are interested in knowing how it is being used. P ## How to use this repository -The current build of the PDF is avaliable in GitHub Actions. Visit https://github.com/openSUSE/lessons/actions/workflows/pdf.yml, click the latest entry with a green checkmark next to it and click on `lesson-plan.pdf` down at the bottom. This will give you a zip file containing the PDF. This is not an ideal solution, if you have any suggestions on how to improve this Action feel free to open a PR. +The current build of the PDF is avaliable in GitHub Actions. Visit , click the latest entry with a green checkmark next to it and click on `lesson-plan.pdf` down at the bottom. This will give you a zip file containing the PDF. This is not an ideal solution, if you have any suggestions on how to improve this Action feel free to open a PR. ## Setting up your build environment @@ -28,4 +28,4 @@ Once you're ready to propose your changes, make a PR to this repo. [Material for ## License -This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. +This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..869a108 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,13 @@ +--- +hide: + - navigation + - toc +--- + +# openSUSE Lesson Plan + +This project is a collaborative effort for designing and preparing lesson plans for teachers, home educators, students and self-learners. The lesson plans focus on segments of open-source software development, culture and contribution. The material is helpful for curriculums involving the teaching of IT courses in primary, secondary and higher education. + +## Feedback on use of content + +The developers of this content are interested in knowing how it is being used. Please send us feedback in comments or contribute with a pull request, or open up an issue. We plan to run a contest after all the content is completed. diff --git a/docs/installing-opensuse.md b/docs/installing-opensuse.md index 1ee5e92..dbf4229 100644 --- a/docs/installing-opensuse.md +++ b/docs/installing-opensuse.md @@ -2,7 +2,6 @@ ## Concepts Learned -- How to install Linux - How to install openSUSE ## Standards @@ -38,7 +37,7 @@ - Watch [openSUSE: A Beautiful Linux Distro](https://youtu.be/yf3b6b1iHIA) as a class the to understand how to download and install openSUSE. Discuss the differences between Tumbleweed and Leap. - Watch the first 4 minutes of [openSUSE Leap 15.2 | Review and Final Thoughts](https://youtu.be/wP4IvrsdZZo) and discuss the reasons for selecting different types of software options. -- Download an image of openSUSE from; https://get.opensuse.org/ +- Download an image of openSUSE from; - Use a USB/microUSB and application/commands of your choice to write an image - Have students read and discuss [Rolling vs. Point Release Linux Distros – Which is better?](https://www.fosslinux.com/2805/linux-rolling-release-vs-point-release-and-which-is-better.htm) diff --git a/mkdocs.yml b/mkdocs.yml index 39c9187..1d77109 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,21 +1,26 @@ -site_name: Mitosomat Dokumentation -theme: - name: material - features: - - navigation.tracking - - navigation.sections - palette: - scheme: preference - primary: green - accent: red -markdown_extensions: - - admonition - - pymdownx.details - - pymdownx.superfences +site_name: openSUSE Lessons +site_url: https://lessons.openSUSE.com/ +site_author: openSUSE +site_description: Learn openSUSE Your comprehensive guide to the open-source distribution. +repo_name: openSUSE/lessons +repo_url: https://github.com/openSUSE/lessons +edit_uri: https://github.com/openSUSE/lessons/tree/main/docs +copyright: Copyright (C) 2024 openSUSE contributors. + +nav: + - openSUSE Lessons: index.md + - Learn: + - Benefits of OSS: benefits-of-open-source-software.md + - Contribute: + - Contributing: contributing.md + - Code of Conduct: code_of_conduct.md + - License: license.md + + plugins: - with-pdf: author: openSUSE contributors - copyright: Copyright (C) 2021 openSUSE contributors. + copyright: Copyright (C) 2024 openSUSE contributors. cover: true cover_title: Linux Lesson Plan cover_subtitle: Free and Open Source Software @@ -24,3 +29,45 @@ plugins: output_path: ./lesson-plan.pdf toc_title: Contents back_cover: false + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences + +theme: + name: "material" + icon: + edit: material/pencil + #logo: assets/opensuse-doc.png + #favicon: assets/opensuse-doc.png + #custom_dir: docs/theme + features: + - navigation.tracking + - content.code.copy + - content.action.edit + - content.tooltips + - content.code.annotate + - navigation.tabs + - navigation.sections + + palette: + - scheme: default + primary: green + accent: red + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + - scheme: slate + primary: green + toggle: + icon: material/brightness-4 + name: Switch to light mode + + font: + text: Roboto + code: Roboto Mono + features: + - content.code.copy + - content.code.annotate