Skip to content

Commit fc65dd4

Browse files
authored
READMEをリファクタリング: セットアップ情報を分離し記事一覧を表示 (#24)
1 parent d53fb11 commit fc65dd4

File tree

4 files changed

+75
-119
lines changed

4 files changed

+75
-119
lines changed

README.md

Lines changed: 24 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,28 @@ Qiita記事をGitHubで管理するためのリポジトリです。
44

55
## セットアップ
66

7-
### 1. Qiitaアクセストークンの取得
7+
セットアップ方法については [SETUP.md](./SETUP.md) をご覧ください。
8+
9+
## 記事一覧
10+
11+
全 18 件の記事があります。
12+
13+
- [開発マネージャがメンバーに知って欲しい事 ※随時更新](./public/開発マネージャがメンバーに知って欲しい事.md) (更新: 2025-04-22)
14+
- [最近良く見る「アウトプット」「アウトカム」「インパクト」とは何か?](./public/最近良く見る「アウトプット」「アウトカム」「インパクト」とは何か?.md) (更新: 2025-03-17)
15+
- [理解しやすいコードの書き方~理解容易性の7つの観点~](./public/理解しやすいコードの書き方~理解容易性の7つの観点~.md) (更新: 2025-03-14)
16+
- [AWS ネットワーク構成図サンプル(VPC)](./public/AWS_ネットワーク構成図サンプル(VPC).md) (更新: 2024-12-23)
17+
- [JSTQB テスト自動化エンジニア v2016 要約・意訳](./public/JSTQB_テスト自動化エンジニア_v2016_要約・意訳.md) (更新: 2024-10-10)
18+
- [やりたくない仕事をやらずに済む方法](./public/やりたくない仕事をやらずに済む方法.md) (更新: 2023-12-11)
19+
- [CodeceptJSにトライしてみた。](./public/CodeceptJSにトライしてみた.md) (更新: 2023-11-11)
20+
- [開発に便利なユニットテストの使い方](./public/開発に便利なユニットテストの使い方.md) (更新: 2023-01-13)
21+
- [認定スクラムマスター資格をとるまでの流れ](./public/認定スクラムマスター資格をとるまでの流れ.md) (更新: 2022-10-07)
22+
- [たまに使うGitコマンド集](./public/たまに使うGitコマンド集.md) (更新: 2022-09-16)
23+
- [GitLab CEでGitHubをミラーリングする](./public/GitLab_CEでGitHubをミラーリングする.md) (更新: 2022-05-02)
24+
- [なぜ単純な増員は生産性の改善に直結しないのか?](./public/なぜ単純な増員は生産性の改善に直結しないのか?.md) (更新: 2022-03-05)
25+
- [実践:「質とスピード」を維持するには](./public/実践:「質とスピード」を維持するには.md) (更新: 2021-12-21)
26+
- [AWS CDKはグローバルでインストールしない](./public/AWS_CDKはグローバルでインストールしない.md) (更新: 2020-12-25)
27+
- [AWS CLIがMINGW64でc:\program: bad interpreter: No such file or directoryエラーになる場合の回避方法](./public/AWS_CLIがMINGW64でc_program_bad_interpreter_No_such_file_or_directoryエラーになる場合の回避方法.md) (更新: 2020-12-25)
28+
- [AWS CDKで「Error: ARNs must have at least 6 components: undefined」になる時の解決策](./public/AWS_CDKで「Error_ARNs_must_have_at_least_6_components_undefined」になる時の解決策.md) (更新: 2020-12-24)
29+
- [長く売れる製品を考える為の観点](./public/長く売れる製品を考える為の観点.md) (更新: 2020-12-24)
30+
- [JIRAでGitHub Enterpriseを連携する際の設定値の具体例](./public/JIRAでGitHub_Enterpriseを連携する際の設定値の具体例.md) (更新: 2020-12-02)
831

9-
1. [Qiitaの設定ページ](https://qiita.com/settings/tokens/new)でアクセストークンを生成
10-
2. 必要な権限: `read_qiita`, `write_qiita`
11-
12-
### 2. GitHubシークレットの設定
13-
14-
1. リポジトリの Settings > Secrets and variables > Actions に移動
15-
2. `QIITA_TOKEN` という名前でシークレットを追加
16-
3. 上記で取得したQiitaアクセストークンを値として設定
17-
18-
## 使用方法
19-
20-
### 既存記事の取得
21-
22-
1. GitHubリポジトリの Actions タブに移動
23-
2. 「既存記事の取得」ワークフローを選択
24-
3. 「Run workflow」ボタンをクリックして手動実行
25-
26-
このワークフローは、Qiitaに投稿済みの記事を取得し、リポジトリに保存します。
27-
28-
### 記事の公開
29-
30-
1. `public/` ディレクトリ内の記事ファイルを編集または新規作成
31-
2. 変更をコミットしてブランチにプッシュ
32-
3. main ブランチへのプルリクエストを作成
33-
4. プルリクエストをマージ
34-
35-
プルリクエストがマージされると、自動的に記事がQiitaに公開されます。
36-
37-
## 品質チェック
38-
39-
### Markdown Lint
40-
41-
プルリクエストを作成すると、reviewdogを使用したmarkdown-lintの自動チェックが実行されます。
42-
43-
- チェック対象: すべての `.md` ファイル
44-
- レビューコメント: 問題が見つかった場合、PRに自動的にコメントが投稿されます
45-
- 設定ファイル: `.markdownlint.json`
46-
47-
無効化されているルール:
48-
- MD013: 行の長さ制限(Qiita記事では長い行が一般的なため)
49-
- MD033: HTML使用(Qiita記事ではHTMLタグが使用されることがあるため)
50-
- MD041: 最初の行は見出しであるべき(Qiitaの記事にはfrontmatterがあるため)

SETUP.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# セットアップガイド
2+
3+
このドキュメントでは、Qiita記事をGitHubで管理するためのセットアップ方法を説明します。
4+
5+
## セットアップ
6+
7+
### 1. Qiitaアクセストークンの取得
8+
9+
1. [Qiitaの設定ページ](https://qiita.com/settings/tokens/new)でアクセストークンを生成
10+
2. 必要な権限: `read_qiita`, `write_qiita`
11+
12+
### 2. GitHubシークレットの設定
13+
14+
1. リポジトリの Settings > Secrets and variables > Actions に移動
15+
2. `QIITA_TOKEN` という名前でシークレットを追加
16+
3. 上記で取得したQiitaアクセストークンを値として設定
17+
18+
## 使用方法
19+
20+
### 既存記事の取得
21+
22+
1. GitHubリポジトリの Actions タブに移動
23+
2. 「既存記事の取得」ワークフローを選択
24+
3. 「Run workflow」ボタンをクリックして手動実行
25+
26+
このワークフローは、Qiitaに投稿済みの記事を取得し、リポジトリに保存します。
27+
28+
### 記事の公開
29+
30+
1. `public/` ディレクトリ内の記事ファイルを編集または新規作成
31+
2. 変更をコミットしてブランチにプッシュ
32+
3. main ブランチへのプルリクエストを作成
33+
4. プルリクエストをマージ
34+
35+
プルリクエストがマージされると、自動的に記事がQiitaに公開されます。
36+
37+
## 品質チェック
38+
39+
### Markdown Lint
40+
41+
プルリクエストを作成すると、reviewdogを使用したmarkdown-lintの自動チェックが実行されます。
42+
43+
- チェック対象: すべての `.md` ファイル
44+
- レビューコメント: 問題が見つかった場合、PRに自動的にコメントが投稿されます
45+
- 設定ファイル: `.markdownlint.json`
46+
47+
無効化されているルール:
48+
49+
- MD013: 行の長さ制限(Qiita記事では長い行が一般的なため)
50+
- MD033: HTML使用(Qiita記事ではHTMLタグが使用されることがあるため)
51+
- MD041: 最初の行は見出しであるべき(Qiitaの記事にはfrontmatterがあるため)

public/sample-upload-test.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

public/アップロードテスト用サンプル記事_ver.3.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)