Skip to content

Commit 4e6986e

Browse files
nullvariantclaude
andauthored
docs(ja): Replace step-by-step text with integrated images (#261)
* docs(ja): replace step-by-step text with integrated images - Quick Start Step 3: Replace 6-step text + 2 screenshots with first-ux.webp - Profile Management: Replace 5 subsections + 3 screenshots with profile-management.webp - Integrated images contain step-by-step Japanese explanations within the image - Keep security notes about SSH key paths not being uploaded - Keep settings.json hint in Quick Start Images hosted on CDN: - images/ja/first-ux.webp (13 steps for initial setup) - images/ja/profile-management.webp (add/edit/delete/reorder operations) 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 * docs(ja): remove redundant Step 4 section Step 4 (Try it out) content is already covered by step 12 of the first-ux.webp integrated image, which shows the profile switching screen with explanation. 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 * docs(ja): integrate GPG section into Quick Start hints - Remove standalone "Option: GPG Signing" section (45 lines) - Add GPG hint between security note and settings.json hint in Step 3 - Improve safety note wording to clarify which operation it refers to (important after the 13-step integrated image) - GPG key ID check command already exists in Troubleshooting section - GPG configuration example already exists in Full Configuration section This consolidates GPG information into the setup flow context, reducing cognitive load while maintaining all necessary information. 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 * docs(ja): move SSH host alias info to troubleshooting section - Remove "SSH Host Alias Usage" section from Quick Start (it was orphaned without a step number after setup steps) - Expand "Wrong profile when pushing?" in Troubleshooting: - Add "New clone" section with host alias examples - Organize existing content under "Existing repository" heading This keeps Quick Start focused on setup flow and moves usage information to where users look when they encounter issues. 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 * docs(ja): move Commands section before Troubleshooting - Reorder sections for better reading flow - Commands (basic reference) now comes before Troubleshooting - Flow: Profile Management -> Commands -> Settings Reference -> ... -> Troubleshooting 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 * fix(deps): update @isaacs/brace-expansion to 5.0.1 Fixes GHSA-7h2j-956f-4vf2 (critical DoS vulnerability) 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 * perf(ja): add loading=lazy to large images Improves initial page load by deferring offscreen images 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 * docs(ja): simplify profile management section and unify image paths - Change demo image path: demo-ja.png -> ja/demo.webp (consistent with other images) - Remove duplicate safety note from Profile Management section (already in Quick Start) - Simplify alt text for profile-management.webp 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 12eac3e commit 4e6986e

3 files changed

Lines changed: 36 additions & 154 deletions

File tree

extensions/git-id-switcher/docs/i18n/ja/README.md

Lines changed: 31 additions & 151 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
<br>
3131

32-
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/demo-ja.png" width="600" alt="デモ">
32+
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/ja/demo.webp" width="600" alt="デモ" loading="lazy">
3333

3434
## 🎯 なぜ Git ID Switcher?
3535

@@ -104,95 +104,20 @@ Host github-work
104104

105105
### ステップ 3: 拡張機能を設定
106106

107-
インストール直後はサンプルプロフィールが用意されています。これを自分用に編集しましょう。
107+
インストール直後はサンプルプロフィールが用意されています。
108+
以下のガイドに沿って、これを自分用に編集しましょう。
108109

109-
1. ステータスバー(右下)のプロフィールアイコンをクリック
110-
2. 一覧下部の「プロフィール管理」を選択
111-
3. サンプルプロフィールの「✏️」をクリックして編集
112-
4. ID・名前・メールアドレスを自分の情報に変更
113-
5. 「SSH Key Path」を選択し、📁ボタンでSSH秘密鍵を参照選択(パスが自動入力される)
114-
6. SSHホスト・その他のオプション項目も必要に応じて設定
110+
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/ja/first-ux.webp" width="600" alt="初回セットアップ手順(13ステップ):ステータスバーからプロフィール管理を開き、編集・新規作成を行う流れ" loading="lazy">
115111

116-
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/management-ui-ja.png" width="600" alt="プロフィール管理UI">
112+
> **鍵ファイルは送信されません**: SSH鍵パスの設定で記録されるのは鍵ファイルのパス(場所)だけです。鍵ファイルの中身がアップロードされたり外部に送信されることはありません。
117113
118-
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/ssh-key-browse-ja.png" width="600" alt="SSH鍵パス参照ボタン">
119-
120-
> **鍵ファイルは送信されません**: この操作で記録されるのは鍵ファイルのパス(場所)だけです。鍵ファイルの中身がアップロードされたり外部に送信されることはありません。
121-
122-
2つ目のプロフィールは「+」ボタンから新規追加してください。
114+
> **GPG署名を使う場合**: プロフィール編集画面で `gpgKeyId` も設定できます。
115+
> GPG鍵IDの確認方法は「[トラブルシューティング](#gpg署名が動作しない)」を参照してください。
123116
124117
> **ヒント**: settings.jsonから直接設定することもできます。
125118
> 拡張機能の設定を開き(`Cmd+,` / `Ctrl+,`)→「Git ID Switcher」を検索 →「settings.jsonで編集」をクリック。
126119
> JSON形式での設定例は「[フル設定例](#フル設定例-4アカウントとssh--gpg)」を参照してください。
127120
128-
SSH鍵パスの詳細な設定手順・プロフィールの編集・削除・並び替えについては「[プロフィール管理](#プロフィール管理)」を参照してください。
129-
130-
### ステップ 4: 使ってみる
131-
132-
1. ステータスバー(右下)のプロフィールアイコンをクリック
133-
2. プロフィールを選択
134-
3. 完了!Git configとSSH鍵が切り替わりました。
135-
136-
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/quickpick-ja.png" width="600" alt="Quick Pick">
137-
138-
### SSHホストエイリアスの使い方
139-
140-
リポジトリをクローンする際、プロフィールに対応したホストを使用します:
141-
142-
```bash
143-
# 仕事用プロフィール(github-workエイリアスを使用)
144-
git clone git@github-work:company/repo.git
145-
146-
# 個人用プロフィール(デフォルトのgithub.comを使用)
147-
git clone git@github.com:kaoru/repo.git
148-
```
149-
150-
---
151-
152-
## オプション: GPG署名
153-
154-
GPGでコミットに署名する場合:
155-
156-
### ステップ 1: GPG鍵IDを確認
157-
158-
```bash
159-
gpg --list-secret-keys --keyid-format SHORT
160-
```
161-
162-
出力例:
163-
164-
```text
165-
sec ed25519/ABCD1234 2024-01-01 [SC]
166-
...
167-
uid [ultimate] 高橋カオル <kaoru@personal.example.com>
168-
```
169-
170-
キーIDは`ABCD1234`です。
171-
172-
### ステップ 2: プロフィールにGPG鍵を追加
173-
174-
```json
175-
{
176-
"gitIdSwitcher.identities": [
177-
{
178-
"id": "personal",
179-
"icon": "🏠",
180-
"name": "高橋カオル",
181-
"service": "GitHub",
182-
"email": "kaoru@personal.example.com",
183-
"description": "個人プロジェクト",
184-
"sshKeyPath": "~/.ssh/id_ed25519_personal",
185-
"gpgKeyId": "ABCD1234"
186-
}
187-
]
188-
}
189-
```
190-
191-
このプロフィールに切り替えると、拡張機能は以下を設定します:
192-
193-
- `git config user.signingkey ABCD1234`
194-
- `git config commit.gpgsign true`
195-
196121
---
197122

198123
## フル設定例: 4アカウントとSSH + GPG
@@ -284,68 +209,20 @@ Host bitbucket.org
284209
ステータスバーをクリック → 一覧下部の「プロフィール管理」で管理画面を開きます。
285210
プロフィールの追加・編集・削除・並び替えはすべてUIから直接操作できます。
286211

287-
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/management-ui-overview-ja.png" width="600" alt="プロフィール管理画面">
212+
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/ja/profile-management.webp" width="600" alt="プロフィール管理:削除・並べ替えの操作ガイド" loading="lazy">
288213

289-
### プロフィールの追加
214+
コマンドパレットから `Git ID Switcher: Delete Identity` でプロフィールを削除することもできます。
290215

291-
1. 管理画面の「+」ボタンをクリック
292-
2. 各フィールドを入力:
293-
- **ID** (必須): 一意の識別子(例: `personal`, `work`
294-
- **名前** (必須): Git user.name
295-
- **メール** (必須): Git user.email
296-
- その他のオプション項目(アイコン、サービス名、説明、SSH鍵パス、SSHホスト、GPG鍵ID)
297-
3. 「保存」を選択
298-
299-
保存後、編集画面に遷移するので、オプション項目も続けて設定できます。
300-
301-
### プロフィールの編集
302-
303-
1. 管理画面で対象プロフィールの「✏️」をクリック
304-
2. 編集したいフィールドを選択
305-
3. 新しい値を入力
306-
307-
フィールドを保存すると編集画面に戻るので、他のフィールドも続けて編集できます。
308-
309-
> **注意**: プロフィールIDは、プロフィールが1件のみの場合に限り変更可能です。
310-
> 2件以上の場合は参照整合性のためロックされます。
311-
312-
### プロフィールの削除
313-
314-
1. 管理画面で対象プロフィールの「🗑️」をクリック
315-
2. 確認ダイアログで「はい」を選択
316-
317-
コマンドパレットから `Git ID Switcher: Delete Identity` でも実行できます。
318-
319-
### プロフィールの並び替え
320-
321-
管理画面で対象プロフィールの「⬆」「⬇」をクリックして順序を変更できます。
322-
この順序はsettings.json内の配列順と連動します。
323-
324-
### SSH鍵パスの設定
325-
326-
SSH鍵パスの入力は、この拡張機能の設定で最も手間のかかる項目です。
327-
管理UIにはファイル参照機能が組み込まれており、パスを手入力する必要がありません。
328-
329-
1. プロフィールの編集画面で「SSH Key Path」を選択
330-
2. 入力欄の右側に「📁」(Browse for SSH key path...)ボタンが表示される
331-
3. ボタンをクリックすると、OSのファイルダイアログが `~/.ssh/` を初期表示して開く
332-
4. 使用したいSSH秘密鍵ファイルを選択(例: `id_ed25519_work`
333-
5. 選択したファイルのパスが `~/.ssh/...` 形式で入力欄に自動入力される
334-
6. パスのバリデーションが即座に実行される
335-
336-
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/ssh-key-dialog-ja.png" width="600" alt="SSH鍵ファイルダイアログ">
337-
338-
<img src="https://assets.nullvariant.com/nullvariant-vscode-extensions/extensions/git-id-switcher/images/ssh-key-autofill-ja.png" width="600" alt="SSH鍵パス自動入力後">
339-
340-
> **鍵ファイルは送信されません**: この操作は鍵ファイルのパス(場所)を記録するだけです。鍵ファイルの中身がアップロードされたり外部に送信されることはありません。
341-
342-
**パス入力のポイント:**
216+
---
343217

344-
- 📁ボタンで参照するのが最も確実(タイプミスの心配なし)
345-
- 手入力も可能(`~/.ssh/id_ed25519_work` のように `~` で始まるパスも使用可)
346-
- セキュリティ上、`~/.ssh/` ディレクトリ配下のファイルのみ指定可能
218+
## コマンド
347219

348-
> **ヒント**: SSH鍵ファイルが `~/.ssh/` にない場合は、先にファイルを移動またはシンボリックリンクを作成してください。
220+
| コマンド | 説明 |
221+
| ---------------------------------------- | ---------------------------- |
222+
| `Git ID Switcher: Select Identity` | プロフィールピッカーを開く |
223+
| `Git ID Switcher: Delete Identity` | プロフィールを削除 |
224+
| `Git ID Switcher: Show Current Identity` | 現在のプロフィール情報を表示 |
225+
| `Git ID Switcher: Show Documentation` | ドキュメントを表示 |
349226

350227
---
351228

@@ -539,6 +416,20 @@ Gitサブモジュールを使用する複雑なリポジトリでは、プロ
539416

540417
### プッシュ時に間違ったプロフィール?
541418

419+
**新規クローン時:**
420+
421+
仕事用リポジトリをクローンする際は、SSH configで設定したホストエイリアスを使用します:
422+
423+
```bash
424+
# 仕事用(github-workエイリアスを使用)
425+
git clone git@github-work:company/repo.git
426+
427+
# 個人用(デフォルトのgithub.comを使用)
428+
git clone git@github.com:yourname/repo.git
429+
```
430+
431+
**既存リポジトリの場合:**
432+
542433
1. リモートURLが正しいホストエイリアスを使用しているか確認:
543434

544435
```bash
@@ -613,17 +504,6 @@ VS Codeなどのエディタは設定スキーマをメモリにキャッシュ
613504

614505
---
615506

616-
## コマンド
617-
618-
| コマンド | 説明 |
619-
| ---------------------------------------- | ---------------------------- |
620-
| `Git ID Switcher: Select Identity` | プロフィールピッカーを開く |
621-
| `Git ID Switcher: Delete Identity` | プロフィールを削除 |
622-
| `Git ID Switcher: Show Current Identity` | 現在のプロフィール情報を表示 |
623-
| `Git ID Switcher: Show Documentation` | ドキュメントを表示 |
624-
625-
---
626-
627507
## 設計哲学
628508

629509
> **「私は誰」を切り替える** — この拡張機能が答える唯一の問い

extensions/git-id-switcher/src/ui/documentationInternal.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export const DOCUMENT_HASHES: Record<string, string> = {
4040
'extensions/git-id-switcher/docs/i18n/haw/README.md': '7b4eaa413c90b8122ee5c59ea703183dc09f2081a305095096213c9a9e1c927f',
4141
'extensions/git-id-switcher/docs/i18n/hu/README.md': '5364b27e458b6b82d7939746fce87a7e46bb6998c8297bf0b2b43433fc7bd966',
4242
'extensions/git-id-switcher/docs/i18n/it/README.md': 'fa16027c907ac7d3740d6af698107242044b756f21712864e7614f216db86ecb',
43-
'extensions/git-id-switcher/docs/i18n/ja/README.md': 'de0636fef9faf4e4195b13f569f3077b0d9636476cc264c7888271bd69fca212',
43+
'extensions/git-id-switcher/docs/i18n/ja/README.md': '18e0bced18ef533a86bfc4796fb13c6516bda5181fcf1304de8217efb9e34f88',
4444
'extensions/git-id-switcher/docs/i18n/ko/README.md': '2e729322bbb406bb53c545bed135e55439d5e6e8bda0b71252cab84247e3a919',
4545
'extensions/git-id-switcher/docs/i18n/pl/README.md': '0ed638015bf96891199c9e3f564cfc3d1a07529f66c371b1b94a9fc5915aacb7',
4646
'extensions/git-id-switcher/docs/i18n/pt-BR/README.md': '35e789a0c76a35853316fc2825e0209431b73eddcf0e39452548b748ee1c5155',

package-lock.json

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)