Skip to content
This repository was archived by the owner on May 23, 2023. It is now read-only.

Commit 85be4c4

Browse files
committed
switch to docusaurus
1 parent d5fc932 commit 85be4c4

File tree

213 files changed

+9257
-52374
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

213 files changed

+9257
-52374
lines changed

.babelrc

-15
This file was deleted.

.dockerignore

-5
This file was deleted.

.editorconfig

-12
This file was deleted.

.github/workflows/build.yml

-41
This file was deleted.

.gitignore

+18-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
# Project dependencies
2-
.cache
3-
node_modules
4-
yarn-error.log
1+
# Dependencies
2+
/node_modules
53

6-
# Build directory
7-
/public
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
812
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

.prettierrc

-5
This file was deleted.

.vscode/settings.json

-5
This file was deleted.

Dockerfile

-21
This file was deleted.

README.md

+23-50
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,41 @@
1-
# [Course material](https://docker-hy.github.io)
1+
# Website
22

3-
If you have any questions, send an email to [email protected] or send a message through the course Discord group.
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
44

5-
## Material template
5+
### Installation
66

7-
This repository contains both the source code of this course's webpage and the source for the content of the course. The content is located in the `data` folder and everything else is for the website.
8-
9-
## Contributing to the content
10-
11-
If you spot a mistake, feel free to open an issue in this repo after consulting with the course assistants.
12-
13-
If you'd help us making the correction, you can open a pull request with your proposed changes. You may find these resources helpful for doing this:
14-
15-
* [About pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
16-
* [Markdown tutorial](https://commonmark.org/help/tutorial/)
17-
* [Markdown specification](https://spec.commonmark.org/current/)
18-
19-
## Development environment
20-
21-
Below are instructions on how to setup a development environment on your own machine. These instructions are only relevant to you if you wish to change how the course's website works or looks like. If you don't know how to program or only wish to contribute to the content of the course, please skip this section.
22-
23-
Requirements: recent Node
24-
25-
```sh
26-
npm ci --legacy-peer-deps
27-
npm run develop
7+
```
8+
$ yarn
289
```
2910

30-
Content is in the `data` folder.
31-
32-
Custom markdown components are located in `src/partials`
33-
34-
If you want to use local, unpublished version of moocfi-quizzes for testing, run `./use-local-quizzes.sh` before running the application.
35-
If your configuration differs from the default, add the path to the moocfi-quizzes as the first argument to the script.
36-
An illustration of the default configuration:
11+
### Local Development
3712

3813
```
39-
(parent directory)
40-
/ \ 
41-
(this repo) [quizzes](https://github.com/rage/quizzes)
42-
|
43-
packages
44-
|
45-
moocfi-quizzes
14+
$ yarn start
4615
```
4716

48-
Sometimes when making certain type of changes to the queries, you may wish to restart Gatsby automatically each time the development server exits. To accomplish this you can run the script: `./develop-loop.sh`.
49-
50-
## Authors
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
5118

52-
Material template created by [Henrik Nygren](https://github.com/nygrenh) and [Antti Leinonen](https://github.com/Redande).
19+
### Build
5320

54-
# License
21+
```
22+
$ yarn build
23+
```
5524

56-
## Material template
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
5726

58-
Copyright 2018 [Henrik Nygren](https://github.com/nygrenh), [Antti Leinonen](https://github.com/Redande), and the [Agile Education Research group](https://www.helsinki.fi/en/researchgroups/data-driven-education).
27+
### Deployment
5928

60-
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at
29+
Using SSH:
6130

62-
http://www.apache.org/licenses/LICENSE-2.0
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
6334

64-
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
35+
Not using SSH:
6536

66-
## Course material
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
6740

68-
The course material is licensed under a [Creative Commons BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/deed) license.
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

bin/check-code-style.sh

-17
This file was deleted.

bin/update-material-template.sh

-34
This file was deleted.

course-metadata.json

-40
This file was deleted.

course-settings.js

-23
This file was deleted.

develop-loop.sh

-7
This file was deleted.

docs/credits.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_class_name: hidden
3+
---
4+
5+
# Credits
6+
7+
The DevOps with Docker course was created by [Jami Kousa](https://github.com/jakousa) with the help of University of Helsinki's Tietojenkäsittelytieteen osaston sovelluskehitysakatemia ([Toska](https://toska.dev)) and [numerous course attendees](https://github.com/docker-hy/docker-hy.github.io/graphs/contributors). This material is based on [gist by Matti Paksula](https://gist.github.com/matti/0b44eb865d70d98ffe0351fd8e6fa35d). You can help develop the course material as well.
8+
9+
As of 2022 the course was handed off to Matti Luukkainen the legendary creator of Full Stack Open. You can contact him on [email protected].
10+
11+
This material is following the [official Docker guidelines presented on the official website](https://www.docker.com/legal/trademark-guideline). If you find anything conflicting or otherwise prohibited use, please inform us and we'll make the required changes.
12+
13+
This material is licenced under [Creative Commons BY-NC-SA 3.0 -licence](http://creativecommons.org/licenses/by-nc-sa/3.0/), so you can freely use and distribute the material, as long as original creators are credited. If you make changes to material and you want to distribute altered version it must be licenced under the same licence. Usage of material for commercial use is prohibited without permission.

docs/faq.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
---
2-
path: "/faq"
3-
title: "Frequently asked questions"
4-
hidden: false
5-
information_page: true
6-
sidebar_priority: 3000
7-
separator_after: "DevOps with Docker"
2+
sidebar_position: 3
3+
title: "Frequently Asked Questions"
84
---
95

10-
<table-of-contents></table-of-contents>
11-
126
## How do I sign up for the course?
137

148
There's no requirement to sign up for the course until after you've completed the exercises and wish to end your course.

0 commit comments

Comments
 (0)