Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
{
"name": "git-github-tutorial",
"name": "git-github-tutorial-slides",
"image": "alpine/git:latest",
"runArgs": [
"--name=git-github-tutorial"
"--name=git-github-tutorial-slides"
],
"customizations": {
"vscode": {
"extensions": [
"github.vscode-pull-request-github",
"marp-team.marp-vscode",
"mhutchie.git-graph",
"streetsidesoftware.code-spell-checker"
],
"settings": {
Expand Down
29 changes: 0 additions & 29 deletions .github/workflows/gh-pages.yml

This file was deleted.

28 changes: 28 additions & 0 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Publish

on:
release:
types:
- created

jobs:
job:
name: Publish slide deck
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v6
- id: tag
run: echo "tag=${GITHUB_REF##*/}" >> "$GITHUB_OUTPUT"
- uses: docker://marpteam/marp-cli:v4.2.3
with:
args: slides/index.md -o slides/index.html
env:
MARP_USER: root:root
- uses: peaceiris/actions-gh-pages@v4
with:
destination_dir: ${{ steps.tag.outputs.tag }}
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: slides
8 changes: 4 additions & 4 deletions .github/workflows/tests.yml → .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ on:

jobs:
job:
name: Build docs
name: Build slide deck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://marpteam/marp-cli:latest
- uses: actions/checkout@v6
- uses: docker://marpteam/marp-cli:v4.2.3
with:
args: docs/index.md -o docs/index.html
args: slides/index.md -o slides/index.html
env:
MARP_USER: root:root
3 changes: 2 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
MIT License

Copyright (c) 2020-2022 Radio Astronomy Laboratory
Copyright (c) 2020-2022 Radio Astronomy Laboratory, Nagoya University
Copyright (c) 2026 Radio Astronomy Laboratory, Kitami Institute of Technology

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# git-github-tutorial
# git-github-tutorial-slides
Slide deck for the Git and GitHub tutorial

## How to update and publish docs
## How to update and publish the slide deck

1. Create a GitHub issue and a topic branch
1. Commit your updates on `docs/*`
1. Create a GitHub issue and a topic branch `<user>/issue<number>` (e.g. `astropenguin/issue1`)
1. Commit your updates on `slides/*`
1. Merge your commits into the main branch
1. Create a release with a tag `v<year>.<month>.<patch>` (e.g. `v2022.9.0`)
1. The docs will be published at `https://a-lab-nagoya.github.io/git-github-tutorial/<tag>/`
1. Create a release with a tag `v<year>.<month>.<patch>` (e.g. `v2026.1.0`)
1. The slide deck will be published at `https://kit-sas.github.io/git-github-tutorial-slides/<tag>`
Binary file removed docs/images/decode-actions.png
Binary file not shown.
Binary file removed docs/images/decode-code.png
Binary file not shown.
Binary file removed docs/images/decode-issues.png
Binary file not shown.
Binary file removed docs/images/tutorial-commit-1.png
Binary file not shown.
Binary file removed docs/images/tutorial-commit-2.png
Binary file not shown.
Binary file removed docs/images/tutorial-commit-3.png
Binary file not shown.
Binary file removed docs/images/tutorial-github-issue.png
Binary file not shown.
Binary file removed docs/images/tutorial-github-pr-1.png
Binary file not shown.
Binary file removed docs/images/tutorial-github-pr-2.png
Binary file not shown.
Binary file removed docs/images/tutorial-github-pr-3.png
Binary file not shown.
Binary file removed docs/images/tutorial-github-pr-4.png
Binary file not shown.
Binary file removed docs/images/tutorial-github-pr-5.png
Binary file not shown.
Binary file removed docs/images/tutorial-topic-branch-1.png
Binary file not shown.
Binary file removed docs/images/tutorial-topic-branch-2.png
Binary file not shown.
Binary file added slides/images/decode-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added slides/images/decode-readme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added slides/images/tutorial-commit-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added slides/images/tutorial-commit-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added slides/images/tutorial-commit-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added slides/images/tutorial-commit-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added slides/images/tutorial-commit-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added slides/images/tutorial-github-issue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added slides/images/tutorial-github-pr-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added slides/images/tutorial-github-pr-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added slides/images/tutorial-github-pr-3.png
Binary file added slides/images/tutorial-github-pr-4.png
Binary file added slides/images/tutorial-github-pr-5.png
Binary file added slides/images/tutorial-github-pr-6.png
Binary file added slides/images/tutorial-topic-branch-1.png
Binary file added slides/images/tutorial-topic-branch-2.png
199 changes: 127 additions & 72 deletions docs/index.md → slides/index.md

Large diffs are not rendered by default.