From e3a1d08e57612e9e8db20cc87f25bb9ffc8c6fdb Mon Sep 17 00:00:00 2001 From: Matti Luukkainen Date: Sun, 10 Mar 2024 11:28:12 +0200 Subject: [PATCH] part1 --- docs/faq.md | 4 ++++ docs/getting-started.md | 10 +++++++--- docs/part-1/section-6.md | 19 +++++++++++-------- docs/part-1/section-7.md | 4 ++-- docs/part-2/section-5.md | 8 ++++---- docs/part-3/section-6.md | 8 ++++---- 6 files changed, 32 insertions(+), 21 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index c8d4f62e..bf848567 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -3,6 +3,10 @@ sidebar_position: 3 title: "Frequently Asked Questions" --- +## Prerequisites + +The course is suitable for anyone interested in Docker or containerization and has at least some experience with the Linux command line. It also helps if you have some experience in web development. + ## How do I sign up for the course? There's no requirement to sign up for the course until after you've completed the exercises and wish to end your course. diff --git a/docs/getting-started.md b/docs/getting-started.md index 45350d66..d9a9f16b 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,7 +4,7 @@ sidebar_position: 2 # Getting Started -Welcome to the DevOps with Docker course! This course is designed to be completed sequentially, from start to finish. Each part builds on the previous one, so it's important to read the material carefully and complete the exercises in order to develop the necessary skills. +Welcome to the DevOps with Docker course! This course is designed to be completed sequentially, from start to finish. Each part builds on the previous one, so it's important to read the material carefully and complete the exercises to develop the necessary skills. To pass the course, you will need to complete all of the exercises. However, one exercise can be skipped per part, except for the exercises marked as mandatory. The mandatory exercises cannot be skipped. @@ -14,11 +14,15 @@ When submitting your exercises, please follow the instructions provided in the c We hope that you enjoy the course and find it informative and engaging. Good luck! +### Prerequisites + +The course is suitable for anyone interested in Docker or containerization and has at least some experience with the Linux command line. It also helps if you have some experience in web development. + ### Updating of the material for the 2024 edition -The 2024 edition of the course starts officially on 11th March. The material is currently being updated. At the time of writing (9th March) the following parts have already been updated +The 2024 edition of the course starts officially on 11th March. The material is currently being updated. At the time of writing (10th March) the following parts have already been updated -- Part 1, up to and including exercise 1.12 +- Part 1 You may continue already beyond the updated material but beware, there might be some outdated content! diff --git a/docs/part-1/section-6.md b/docs/part-1/section-6.md index e4867bd2..3370d590 100644 --- a/docs/part-1/section-6.md +++ b/docs/part-1/section-6.md @@ -150,17 +150,20 @@ Submit the Dockerfile and the command used. _Do not alter the code of the project_ +TIPS: +- you might need [this](https://docs.docker.com/reference/dockerfile/#env) +- If you have M1/M2 Mac, you might need to build the image with an extra option `docker build --platform linux/amd64 -t imagename .` + ::: :::caution Mandatory Exercise 1.14: Environment -Start both frontend-example and backend-example with correct ports exposed and add ENV to Dockerfile with necessary -information from both READMEs +Start both the frontend and the backend with the correct ports exposed and add [ENV](https://docs.docker.com/reference/dockerfile/#env) to Dockerfile with the necessary information from both READMEs ([front](https://github.com/docker-hy/material-applications/tree/main/example-frontend), [back](https://github.com/docker-hy/material-applications/tree/main/example-backend)). -Ignore the backend configurations until frontend sends requests to `_backend_url_/ping` when you press the button. +Ignore the backend configurations until the frontend sends requests to `_backend_url_/ping` when you press the button. -You know that the configuration is ready when the button for 1.14 of frontend-example responds and turns green. +You know that the configuration is ready when the button for 1.14 of frontend responds and turns green. _Do not alter the code of either project_ @@ -168,13 +171,13 @@ Submit the edited Dockerfiles and commands used to run. ![Backend and Frontend](/img/exercises/back-and-front.png) -The frontend will first talk to your browser. Then the code will be executed from your browser and that will send a message to backend. +The frontend will first talk to your browser. Then the code will be executed from your browser and that will send a message to the backend. ![More information about connection between frontend and backend](/img/exercises/about-connection-front-back.png) -* TIP: When configuring web applications keep browser developer console ALWAYS open, F12 or cmd+shift+I when the browser window is open. Information about configuring cross origin requests is in README of the backend project. - -* TIP: Developer console has multiple views, most important ones are Console and Network. Exploring the Network tab can give you a lot of information on where messages are being sent and what is received as response! +TIPS: +* When configuring web applications keep the browser developer console ALWAYS open, F12 or cmd+shift+I when the browser window is open. Information about configuring cross-origin requests is in the README of the backend project. +* The developer console has multiple views, the most important ones are Console and Network. Exploring the Network tab can give you a lot of information on where messages are being sent and what is received as a response! ::: diff --git a/docs/part-1/section-7.md b/docs/part-1/section-7.md index 1f408c04..046de6ff 100644 --- a/docs/part-1/section-7.md +++ b/docs/part-1/section-7.md @@ -18,13 +18,13 @@ The starting and stopping of containers is a bit annoying, not to mention runnin Enrolling after each part is required for the ECTS credits. Now that you have completed part 1 use the following link to enroll in this course: -- DevOps with Docker, https://www.avoin.helsinki.fi/palvelut/esittely.aspx?s=otm-a1a074e0-dc7f-4644-8796-04fab528ba36 +- DevOps with Docker, https://www.avoin.helsinki.fi/palvelut/esittely.aspx?s=otm-4bd45ab8-8b23-4973-a918-a6b6f7bbb347 If you wish to end in this part and not do the following parts, follow the instructions [at the bottom of getting started page](/getting-started) NOTE! -- Enrollment for the course through the Open University is possible until June 18th, 2023. +- Enrollment for the course through the Open University is possible until June 16th, 2024. - Credits for the course are only available to those students who have successfully enrolled on the course through the Open University and have completed the course according to the instructions. diff --git a/docs/part-2/section-5.md b/docs/part-2/section-5.md index f86fef52..a3c9ca52 100644 --- a/docs/part-2/section-5.md +++ b/docs/part-2/section-5.md @@ -8,18 +8,18 @@ Now we've learned how to setup up vastly more complex applications with up to 5 Are we ready for production yet? Short answer: no. Long answer: depends on the situation. Good thing we have [part 3](/part-3) -**Remember to mark your exercises into the submission application! Instructions on how and what to submit are on the getting started page.** +**Remember to mark your exercises in the submission application! Instructions on how and what to submit are on the getting started page.** ## ECTS Credits Enrolling after each part is required for the ECTS credits. Now that you have completed part 2 use the following link to enroll in this course: -- DevOps with Docker: Docker Compose, https://www.avoin.helsinki.fi/palvelut/esittely.aspx?s=otm-d37daa67-f5b1-4bdb-88a5-98107d2c63ea +- DevOps with Docker: Docker Compose, https://www.avoin.helsinki.fi/palvelut/esittely.aspx?s=otm-c73ef1c6-8fb0-42e8-9052-ef59b01cb409 If you wish to end in this part and not do the following parts, follow the instructions [at the bottom of getting started page](/getting-started) NOTE! -- Enrollment for the course through the Open University is possible until June 18th, 2023. +- Enrollment for the course through the Open University is possible until June 16th, 2024. -- Credits for the course are only available to those students who have successfully enrolled on the course through the Open University and have completed the course according to the instructions. +- Credits for the course are only available to those students who have successfully enrolled in the course through the Open University and have completed the course according to the instructions. diff --git a/docs/part-3/section-6.md b/docs/part-3/section-6.md index 5b18eb5d..f8eb98f9 100644 --- a/docs/part-3/section-6.md +++ b/docs/part-3/section-6.md @@ -2,17 +2,17 @@ title: 'End' --- -**Remember to mark your exercises into the [submission application](https://studies.cs.helsinki.fi/stats/courses/docker2024)! Instructions on how and what to submit are on the getting started page.** +**Remember to mark your exercises in the [submission application](https://studies.cs.helsinki.fi/stats/courses/docker2024)! Instructions on how and what to submit are on the getting started page.** ## ECTS Credits Enrolling after each part is required for the ECTS credits. Now that you have completed part 3 use the following link to enroll in this course: -- DevOps with Docker: security and optimization, https://www.avoin.helsinki.fi/palvelut/esittely.aspx?s=otm-68b6e802-0b55-438c-85aa-1fd9d0ad80be +- DevOps with Docker: security and optimization, https://www.avoin.helsinki.fi/palvelut/esittely.aspx?s=otm-487d8dd8-3a4b-447a-9118-f7bfff8169b6 NOTE! -- Enrollment for the course through the Open University is possible until June 18th, 2023. +- Enrollment for the course through the Open University is possible until June 16th, 2024. -- Credits for the course are only available to those students who have successfully enrolled on the course through the Open University and have completed the course according to the instructions. +- Credits for the course are only available to those students who have successfully enrolled in the course through the Open University and have completed the course according to the instructions.