Skip to content

Commit

Permalink
docs 📝 inital index.md added and bo-oss and better mkdocs configs are…
Browse files Browse the repository at this point in the history
… added

Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
  • Loading branch information
onuralpszr committed Aug 29, 2024
1 parent e1284d9 commit cd56e3f
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 19 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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.

## Setting up your build environment

Expand All @@ -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 <http://creativecommons.org/licenses/by-sa/4.0/> or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 1 addition & 2 deletions docs/installing-opensuse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

## Concepts Learned

- How to install Linux
- How to install openSUSE

## Standards
Expand Down Expand Up @@ -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; <https://get.opensuse.org/>
- 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)

Expand Down
77 changes: 62 additions & 15 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

0 comments on commit cd56e3f

Please sign in to comment.