Skip to content

Commit cbf6fc5

Browse files
authored
chore: Revert updates to honor maintenance mode (#1113)
1 parent 60b4884 commit cbf6fc5

27 files changed

+650
-674
lines changed

.github/dependabot.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "monthly"

.github/steps/-step.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0

.github/steps/0-welcome.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- readme -->
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
<<< Author notes: Step 1 >>>
3+
Choose 3-5 steps for your course.
4+
The first step is always the hardest, so pick something easy!
5+
Link to docs.github.com for further explanations.
6+
Encourage users to open new tabs for steps!
7+
-->
8+
9+
## Step 1: Enable GitHub Pages
10+
11+
_Welcome to GitHub Pages and Jekyll :tada:!_
12+
13+
The first step is to enable GitHub Pages on this [repository](https://docs.github.com/en/get-started/quickstart/github-glossary#repository). When you enable GitHub Pages on a repository, GitHub takes the content that's on the main branch and publishes a website based on its contents.
14+
15+
### :keyboard: Activity: Enable GitHub Pages
16+
17+
1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
18+
1. Under your repository name, click **Settings**.
19+
1. Click **Pages** in the **Code and automation** section.
20+
1. Ensure "Deploy from a branch" is selected from the **Source** drop-down menu, and then select `main` from the **Branch** drop-down menu.
21+
1. Click the **Save** button.
22+
1. Wait about _one minute_ then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.
23+
> Turning on GitHub Pages creates a deployment of your repository. GitHub Actions may take up to a minute to respond while waiting for the deployment. Future steps will be about 20 seconds; this step is slower.
24+
> **Note**: In the **Pages** of **Settings**, the **Visit site** button will appear at the top. Click the button to see your GitHub Pages site.

.github/steps/1-step.md

Lines changed: 0 additions & 30 deletions
This file was deleted.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!--
2+
<<< Author notes: Step 2 >>>
3+
Start this step by acknowledging the previous step.
4+
Define terms and link to docs.github.com.
5+
Historic note: previous version checked for empty pull request, changed to the correct theme `minima`.
6+
-->
7+
8+
## Step 2: Configure your site
9+
10+
_You turned on GitHub Pages! :tada:_
11+
12+
We'll work in a branch, `my-pages`, that I created for you to get this site looking great. :sparkle:
13+
14+
Jekyll uses a file titled `_config.yml` to store settings for your site, your theme, and reusable content like your site title and GitHub handle. You can check out the `_config.yml` file on the **Code** tab of your repository.
15+
16+
We need to use a blog-ready theme. For this activity, we will use a theme named "minima".
17+
18+
### :keyboard: Activity: Configure your site
19+
20+
1. Browse to the `_config.yml` file in the `my-pages` branch.
21+
1. In the upper right corner, open the file editor.
22+
1. Add a `theme:` set to **minima** so it shows in the `_config.yml` file as below:
23+
```yml
24+
theme: minima
25+
```
26+
1. (optional) You can modify the other configuration variables such as `title:`, `author:`, and `description:` to further customize your site.
27+
1. Commit your changes.
28+
1. (optional) Create a pull request to view all the changes you'll make throughout this course. Click the **Pull Requests** tab, click **New pull request**, set `base: main` and `compare:my-pages`.
29+
1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.

.github/steps/2-step.md

Lines changed: 0 additions & 31 deletions
This file was deleted.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!--
2+
<<< Author notes: Step 3 >>>
3+
Start this step by acknowledging the previous step.
4+
Define terms and link to docs.github.com.
5+
Historic note: previous version checked the homepage content was not empty.
6+
-->
7+
8+
## Step 3: Customize your homepage
9+
10+
_Nice work setting the theme! :sparkles:_
11+
12+
You can customize your homepage by adding content to either an `index.md` file or the `README.md` file. GitHub Pages first looks for an `index.md` file. Your repository has an `index.md` file so we can update it to include your personalized content.
13+
14+
### :keyboard: Activity: Create your homepage
15+
16+
1. Browse to the `index.md` file in the `my-pages` branch.
17+
1. In the upper right corner, open the file editor.
18+
1. Type the content you want on your homepage. You can use Markdown formatting on this page.
19+
1. (optional) You can also modify `title:` or just ignore it for now. We'll discuss it in the next step.
20+
1. Commit your changes to the `my-pages` branch.
21+
1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.

.github/steps/3-step.md

Lines changed: 0 additions & 47 deletions
This file was deleted.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<!--
2+
<<< Author notes: Step 4 >>>
3+
Start this step by acknowledging the previous step.
4+
Define terms and link to docs.github.com.
5+
Historic note: previous version checked the file path. Previous version checked the front matter formatting.
6+
-->
7+
8+
## Step 4: Create a blog post
9+
10+
_Your home page is looking great! :cowboy_hat_face:_
11+
12+
GitHub Pages uses Jekyll. In Jekyll, we can create a blog by using specially named files and frontmatter. The files must be named `_posts/YYYY-MM-DD-title.md`. You must also include `title` and `date` in your frontmatter.
13+
14+
**What is _frontmatter_?**: The syntax Jekyll files use is called YAML frontmatter. It goes at the top of your file and looks something like this:
15+
16+
```yml
17+
---
18+
title: "Welcome to my blog"
19+
date: 2019-01-20
20+
---
21+
```
22+
23+
For more information about configuring front matter, see the [Jekyll frontmatter documentation](https://jekyllrb.com/docs/frontmatter/).
24+
25+
### :keyboard: Activity: Create a blog post
26+
27+
1. Browse to the `my-pages` branch.
28+
1. Click the `Add file` dropdown menu and then on `Create new file`.
29+
1. Name the file `_posts/YYYY-MM-DD-title.md`.
30+
1. Replace the `YYYY-MM-DD` with today's date, and change the `title` of your first blog post if you'd like.
31+
> If you do edit the title, make sure there are hyphens between your words.
32+
> If your blog post date doesn't follow the correct date convention, you'll receive an error and your site won't build. For more information, see "[Page build failed: Invalid post date](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)".
33+
1. Type the following content at the top of your blog post:
34+
```yaml
35+
---
36+
title: "YOUR-TITLE"
37+
date: YYYY-MM-DD
38+
---
39+
```
40+
1. Replace `YOUR-TITLE` with the title for your blog post.
41+
1. Replace `YYYY-MM-DD` with today's date.
42+
1. Type a quick draft of your blog post. Remember, you can always edit it later.
43+
1. Commit your changes to your branch.
44+
1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.

0 commit comments

Comments
 (0)