guide

README.md

-# How to create your own Course Site
-
-**Draft guide, not done**
-
-This repository is a template for creating your own Course Site, which if you wish, can be embedded into DTU Learn or other web services.
-
-To get started it is useful to learn about the very few files and folders included in this template.
-
-## Files and folders 
-
-In your project, click the pg_cs folder to enter the folder where the relevant files are located.
-
-What files are supported
-
-reference bib file
-
-Table of content: https://jupyterbook.org/customize/toc.html
-
-Draft
-
-Changing folders and structure
-
-## Great, now what? Building the book/website
-
-As currently configured, you basically only have to alter or add files and "commit" these changes. When doing so, the site will build and update itself, within a few minutes.
-
-
-### Building the book
-
-#### Advanced use
-
-You know to create a basic website, then please proceed to dive into the full Jupyter Book documentation, for more advanced use cases: [Jupyter Book Documentation](https://jupyterbook.org/en/stable/intro.html)
-
-#### Credits
-
-This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) in combination with several other open source projects.
+# Readme
 
+Please see your website frontpage for a quick guide on how to use this repository for a PG Course Site. The address of your site is visible in the top of your repository.
 
+For any questions or comments, please contact mcla@dtu.dk

pg_cs/_toc.yml

@@ -6,7 +6,7 @@ root: intro
 parts:
 - caption: 
   chapters:
-  - file: democontent/demopage
+  - file: democontent/democontent
     sections:
     - file: democontent/notebooks
     - file: democontent/Intro-SymPy
@@ -30,5 +30,5 @@ parts:
 #        - file: exs2
 - caption:  
   chapters:
-  - file: enotes/enotes
+  - file: media/media
 

pg_cs/intro.md

-# PG Course sites
+# How to create your own Course Site
 
-01006 is the English version of the equivalent Danish course 01005 and is a mandatory two-semester course for all bachelor-level engineering students at DTU. This homepage contains information about the course contents and structure and will be updated frequently.
+Based on the fantastic Jupyter Book open source project [Jupyter Book](https://jupyterbook.org/en/stable/intro.html)
 
-Each lesson (except for days with theme exercises) begins with a lecture followed by an exercise session for the rest of the day. All students are divided into groups and assigned a teacher and study area.
+This repository is a template for creating your own Course Site, which can be embedded into DTU Learn or other web services. In this way, the same content will be visible on both DTU Learn, and on the web. Everything is already set up, you alter or add content and see the changes applied on the website within a minute or two. If anything breaks, we can roll back to any previous version.
 
- **Location of lectures** 
-The lectures take place in Auditorium 42, Building 303A
+The point of PG Course Sites is to enable rapid and simple content creation, support content collaboration and sharing between PG courses and use tools which are Python relevant. All content can easily be migrate/converted to other services or solutions if needed. If we lack features, we can contribute to the underlying project and have it implemented.
 
- **Lecturer and course coordinator** 
-Steeven Hegelund Spangsdorf, shsp@dtu.dk.
+To get started, it is useful to learn about the very few files and folders included in this repository. This is a demonstration project, so many of the files and folders are not needed and can be deleted or altered.
 
- **Location of exercise sessions** 
-The entire bottom floor of building 302 is reserved from 12:00-17:00 on Long Days and from 14:00-17:00 on Short Days. Here all our study areas can be found.
+## Files and folders
+In your project, which you can find here [DTU Compute Gitlab](https://lab.compute.dtu.dk) (Use the "DTU Login" tab or if from Compute, the "DTU Compute" tab), enter the project and click the pg_cs folder to see all the relevant files and folders. It should look something like this:
 
- **Teachers** (present during Long Days) 
-Our four teachers are assigned the following groups and study areas:
+![Structure](./media/g4.png)
 
-* **Dušana Milinkovic**: Group 1, 302/0NW (bottom floor, north-west corner)
-* **Eric Brand**: Group 2, 302/0SW
-* **Ioannis Karras**: Group 3, 302/0NE
-* **Raquel Ribeiro**: Group 4, 302/0SE
-* Group 5 may find seats in any study area with any teacher. Steeven will be assessing the homework.
+### Lets edit a file
+If you want to try to edit a file, try clicking the "intro" file and click "edit": ![Edit](./media/g5.png) (You may need to press "edit" once more the first time).
 
-Each group has its own module on [DTU Learn](https://learn.inside.dtu.dk/) and you can tell which group you belong to by checking Learn. From Learn you can reach out to your teacher, and from here you teacher will communicate directly with you with shared messages. 
+This is a Markdown file, you can use standard Markdown syntax for content. If you press the "Preview" tab, you can see the expected output right away:
 
-On Short Days the teachers will not be present, and challenging exercises are thus prioritised for Long Days. A few TAs/student assistants will be present on Short Days, but fewer and mainly with the purpose of providing technical support.
+![Preview](./media/g7.png)
 
-## Digitally-based education
-In 01006 Advanced Engineering Mathematics 1 we are putting effort into using the possibilities that information technology (IT) and the world of digital tools provide. We still do believe that presence, lectures and group work are decisive elements in the learning of mathematics, but we also know that students wish to find a way of studying that suits each student the best.
+If you want to see what can be done with plain Markdown, see this cheatsheet: [Cheatsheet](https://www.markdownguide.org/basic-syntax/)
 
-We therefore wish to support your studies with a variety of web-based learning objects and activities. Traditional learning materials such as textbooks and printed weekly agendas are replaced by digital eNotes (you can still purchase a printed book-version of the syllabus in the bookstore, Polyteknisk Boghandel, though) and electronic exercises that use link technology, which points towards a non-linear learning style. We will be utilising a quizzing and testing system called Möbius (sometimes obsoletely referred to as MapleTA) that dynamically can provide a rich and unique quiz experience. Also, all lectures will be live-streamed and recorded for later access. 
+When you are done altering the file, scroll down and press "Commit" which will apply your changes and start updating the site:
 
-To make the course even better we need your reactions and opinions. We will frequently evaluate the course. Please give your contribution to amending our mathematics course in order for mathematics to be an even more important element in your investigation (and that of your fellow students) of your engineering subject and your world.
+![Commit](./media/g8.png)
 
-## About the Mathematics Software Maple
-The professional mathematical software Maple produced by MapleSoft is an important part of our teaching of Advanced Engineering Mathematics 1. We will begin using the software about four weeks in and an introduction as well as demos will be made available for you to get comfortable with it quickly.
+Go to the frontpage of your website (if you altered the "intro.md" file, which is the frontpage) and you should see the alterations you made within a short while. You may need to refresh the page, before changes are seen. Your website address can be found in the description of the repository (above all the files in the project). 
 
-About the use of software and IT in mathematics in general: Mathematics must be built from the bottom-up and it is crucial that you have studied and have manual insight into the methods and manipulations that lead to the desired results. But it is likewise important that you get a feeling for what mathematics can be used for in the real world, where complicated models and huge computations apply.
+### Structure
+The structure is very simple. The only files needed to have the website running are the files outside the "pg_cs" folder (please do not touch) and these:
 
-Maple supports both! Maple is a universe of possibilities for studying mathematics, both concerning the understanding of fundamental concepts as well as when the task is to investigate real world problems through visualisations, analytic models and numerical computations. Maple is an advanced computation and plotting tool at your free disposal with the DTU license.
+```console
+pg_cs/
+├── _config.yml
+├── _toc.yml
+└── intro.md
+```
 
-Therefore, it is important that you are always aware of how you can utilise the possibilities that Maple offers. What is the learning objective for your current activity? And which Maple-commands and styles let you reach this goal most effectively? Just always remember that Maple like any other such software is _not smarter_, just _faster_. Make sure that you always fully understand each step that takes place when you use Maple to perform tasks for you.
+Anything else can removed and are purely files and folders for demonstration purpose.
+
+##### _config.yml
+The config file is where you configure the project. You should not need to alter anything in this file but can do so, if you want to make changes.
+
+##### _toc.yml (Table of Content)
+This file is your table of content and will control which files are build, and how they all interconnect. You can alter this file and rearrange the site if you like, or include newly created files as well. Any file not listed in the toc, will currently not be build, but this can be changed in the configuration file if you wish.
+
+For further explanation on the toc file: [Toc file](https://jupyterbook.org/customize/toc.html)
+
+##### intro
+This is the frontpage of you website. You can alter this freely but not remove it.
+
+### File formats supported
+This project supports several different file formats for content creation, these are the primary:
+
+**Markdown files (*.md):** Usually used to create text heavy, content pages. This project further supports the MyST Markdown language as well, which is not standard Markdown.  
+**ReStructuredText (*.rst):** Used primarily within the Python community, basically does the same as Markdown, but may be better (or worse) for your use case.  
+**Jupyter Notebook (*.ipynb):** Used if you want to show Notebook files on your website, they will be run during the website build process. ipynb files mainly makes sense to edit, if you do so in a Python Jupyter environment.  
+
+For all supported formats, please see the official documentation: [File formats](https://jupyterbook.org/en/stable/file-types/index.html)
+
+You can use LaTeX directly on all pages [LaTeX support](https://jupyterbook.org/en/stable/content/math.html)
+
+### Upload or Create new files and folders
+You can create/upload new files or folders by pressing the "+" sign:
+
+![New file](./media/g10.png)
+
+This would also be the way to upload any images or pdf files you might want to include on the website.
+
+## Advanced use
+For much faster workflow, you can git clone this repository to your laptop, and work with the files and folders directly. When done, you can git push the changes to lab.compute.dtu.dk and the site will build automatically (and store the latest changes).
+
+Another route is to use the "Web Editor" in GitLab, which lets you alter multiple files simultaneously before committing:
+
+![Web Editor](./media/g12.png)
+
+## Embedding into DTU Learn Course
+Please read the DTU Learn support guide: [Creating Custom links](https://learnsupport.dtu.dk/teachers/customize-navbar.php)
+
+When you create the Custom link, please set the option to "window mode" so that the Learn menu stays in place in the top part of the browser.
+
+If you embed the site into your Learn course, DTU students never have to leave Learn to see your content.
+
+## Inspiration
+You can find multiple examples of content created in Jupyter Book right here: [Examples](https://executablebooks.org/en/latest/gallery/)
+
+**For Chemistry which might not feel at home initially**, please have a look in this book, which also has interactive 3D models, and much more: [Chem Example](https://kthpanor.github.io/echem/docs/visualize/struct_vis.html) (You can turn and interact with the 3D models on the page) There are many options in general on how to utilize Python for teaching.
+
+There are many more examples on the web which covers all/most fields.
+
+Please proceed to dive into the full Jupyter Book documentation, for more advanced use cases: [Jupyter Book Documentation](https://jupyterbook.org/en/stable/intro.html)
+
+## Credits
+This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) in combination with several other open source projects.
+
+Questions or comments, please contact mcla@dtu.dk