[インデックス 12219] ファイルの概要

このコミットは、Go言語の公式ドキュメントにおける「Wikiチュートリアル」の配置と参照方法を整理するものです。具体的には、doc/codelab/wiki ディレクトリにあったチュートリアル関連ファイルを doc/articles/wiki へ移動し、それに伴い関連するHTMLファイル内のリンクやテキストを更新しています。これにより、ドキュメントの構造がより論理的になり、チュートリアルが「記事（articles）」の一部として明確に位置づけられました。

コミット

コミットハッシュ: cd1a2f7e74b9a697cacfeee971cdba506b032eb2
作者: Andrew Gerrand adg@golang.org
日付: Mon Feb 27 11:25:43 2012 +1100

コミットメッセージ:

doc: move wiki tutorial into articles directory, rmdir doc/codelab

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/5701050

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/cd1a2f7e74b9a697cacfeee971cdba506b032eb2

元コミット内容

doc: move wiki tutorial into articles directory, rmdir doc/codelab

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/5701050

変更の背景

この変更の背景には、Go言語の公式ドキュメントの構造化と整理があります。以前は「codelab」（コードラボ、つまり実践的なコーディング演習）というカテゴリに属していたWikiチュートリアルが、より広範な「articles」（記事）というカテゴリに移動されました。これは、チュートリアルが単なるコード演習に留まらず、より一般的な解説記事としての側面も持つため、その位置づけを明確にする意図があったと考えられます。

また、doc/codelab ディレクトリ自体が削除されたことから、codelab というカテゴリが廃止されたか、あるいはその内容が articles や他の適切なディレクトリに統合されたことを示唆しています。これにより、ドキュメント全体のディレクトリ構造が簡素化され、ユーザーが目的のコンテンツを見つけやすくなるという利点があります。

前提知識の解説

Go言語のドキュメント構造: Go言語の公式ドキュメントは、通常、doc ディレクトリ以下に配置されます。ここには、インストールガイド、言語仕様、チュートリアル、記事などが含まれます。
Codelab (コードラボ): Googleが提供する実践的なハンズオン形式のチュートリアルを指すことが多いです。Go言語の文脈では、特定の技術や機能について、ステップバイステップでコードを書きながら学ぶ形式のコンテンツを指していました。
Articles (記事): より広範な概念で、特定のトピックに関する解説、ベストプラクティス、設計思想など、チュートリアルよりも網羅的または概念的な内容を含む文書を指します。
git mv (rename): Gitにおけるファイルやディレクトリの移動・名称変更を意味します。similarity index 100% は、ファイルの内容が変更されずにパスだけが変更されたことを示します。
HTMLコメント内のメタデータ:  のような形式は、HTMLファイル内に構造化されたメタデータ（この場合はタイトル情報）を埋め込む一般的なパターンです。これは、ドキュメント生成ツールやサイトジェネレーターがコンテンツのタイトルを動的に取得するために利用されることがあります。

技術的詳細

このコミットは、主に以下の技術的変更を含んでいます。

ディレクトリ構造の変更:
- doc/codelab/wiki ディレクトリとその配下の全ファイルが doc/articles/wiki へ移動されました。これは、git mv コマンドに相当する操作であり、Gitの差分表示では rename from と rename to の形式で示されています。多くのファイルで similarity index 100% と表示されていることから、ファイルの内容自体は変更されずにパスのみが変更されたことがわかります。
- 移動後、doc/codelab ディレクトリは空になり、最終的に削除されました。
HTMLファイルの内容変更:
- doc/codelab/wiki/index.html と doc/codelab/wiki/wiki.html (移動後は doc/articles/wiki/index.html と doc/articles/wiki/wiki.html) の2つのHTMLファイルで内容の変更がありました。
  - 既存のHTMLコメント  が削除されました。
  - 代わりに、JSON形式のメタデータを含む新しいHTMLコメント  が追加されました。これは、ドキュメントのタイトルをプログラム的に抽出するための標準的な方法として導入された可能性があります。
  - ファイル内のテキストで「Codelab」という単語が「tutorial」に置き換えられました。これにより、コンテンツが新しいカテゴリ名に沿った表現に統一されました。
ドキュメント内リンクの更新:
- Go言語のドキュメントサイト全体のナビゲーションや参照を管理する doc/docs.html、doc/install-source.html、doc/install.html の3つのHTMLファイルが更新されました。
- これらのファイル内で、旧パス /doc/codelab/wiki/ を参照していたリンクが、新パス /doc/articles/wiki/ に変更されました。
- 同時に、リンクテキストも「Wiki Codelab」から「Wiki Tutorial」へと変更され、一貫性が保たれています。

これらの変更は、Go言語のドキュメントが時間の経過とともに進化し、より整理された構造を持つように継続的に改善されていることを示しています。

コアとなるコードの変更箇所

このコミットにおけるコアとなる変更箇所は以下のファイル群です。

ファイルパスの変更（リネーム）:
- doc/codelab/wiki/Makefile -> doc/articles/wiki/Makefile
- doc/codelab/wiki/edit.html -> doc/articles/wiki/edit.html
- doc/codelab/wiki/final-noclosure.go -> doc/articles/wiki/final-noclosure.go
- doc/codelab/wiki/final-noerror.go -> doc/articles/wiki/final-noerror.go
- doc/codelab/wiki/final-parsetemplate.go -> doc/articles/wiki/final-parsetemplate.go
- doc/codelab/wiki/final-template.go -> doc/articles/wiki/final-template.go
- doc/codelab/wiki/final.go -> doc/articles/wiki/final.go
- doc/codelab/wiki/get.go -> doc/articles/wiki/get.go
- doc/codelab/wiki/htmlify.go -> doc/articles/wiki/htmlify.go
- doc/codelab/wiki/http-sample.go -> doc/articles/wiki/http-sample.go
- doc/codelab/wiki/notemplate.go -> doc/articles/wiki/notemplate.go
- doc/codelab/wiki/part1-noerror.go -> doc/articles/wiki/part1-noerror.go
- doc/codelab/wiki/part1.go -> doc/articles/wiki/part1.go
- doc/codelab/wiki/part2.go -> doc/articles/wiki/part2.go
- doc/codelab/wiki/srcextract.go -> doc/articles/wiki/srcextract.go
- doc/codelab/wiki/test.sh -> doc/articles/wiki/test.sh
- doc/codelab/wiki/test_Test.txt.good -> doc/articles/wiki/test_Test.txt.good
- doc/codelab/wiki/test_edit.good -> doc/articles/wiki/test_edit.good
- doc/codelab/wiki/test_view.good -> doc/articles/wiki/test_view.good
- doc/codelab/wiki/view.html -> doc/articles/wiki/view.html

HTMLファイルの内容変更:

doc/codelab/wiki/index.html (変更後: doc/articles/wiki/index.html)

--- a/doc/codelab/wiki/index.html
+++ b/doc/articles/wiki/index.html
@@ -1,8 +1,11 @@
 <!-- Codelab: Writing Web Applications -->
+<!--{
+	"Title": "Writing Web Applications"
+}-->
+\n <h2>Introduction</h2>
\n <p>\n-Covered in this codelab:\n+Covered in this tutorial:\n </p>\n <ul>
 <li>Creating a data structure with load and save methods</li>
@@ -33,7 +36,7 @@ Install Go (see the <a href="/doc/install.html">Installation Instructions</a>).\n </p>\n \n <p>\n-Make a new directory for this codelab and cd to it:\n+Make a new directory for this tutorial and cd to it:\n </p>\n \n <pre>

doc/codelab/wiki/wiki.html (変更後: doc/articles/wiki/wiki.html)

--- a/doc/codelab/wiki/wiki.html
+++ b/doc/articles/wiki/wiki.html
@@ -1,8 +1,11 @@
 <!-- Codelab: Writing Web Applications -->
+<!--{
+	"Title": "Writing Web Applications"
+}-->
+\n <h2>Introduction</h2>
\n <p>\n-Covered in this codelab:\n+Covered in this tutorial:\n </p>\n <ul>
 <li>Creating a data structure with load and save methods</li>
@@ -33,7 +36,7 @@ Install Go (see the <a href="/doc/install.html">Installation Instructions</a>).\n </p>\n \n <p>\n-Make a new directory for this codelab and cd to it:\n+Make a new directory for this tutorial and cd to it:\n </p>\n \n <pre>

ドキュメント内リンクの更新:

doc/docs.html

--- a/doc/docs.html
+++ b/doc/docs.html
@@ -65,7 +65,7 @@ Answers to common questions about Go.\n  <h3>Other introductory articles</h3>\n \n  <ul>\n-<li><a href="codelab/wiki/">Writing Web Applications</a> - \n+<li><a href="/doc/articles/wiki/">Writing Web Applications</a> - \n  	building a simple web application.</li>\n  <li><a href="go_for_cpp_programmers.html">Go for C++ Programmers</a></li>
 </ul>

doc/install-source.html

--- a/doc/install-source.html
+++ b/doc/install-source.html
@@ -235,8 +235,8 @@ read <a href="/doc/code.html">How to Write Go Code</a>.\n  </p>\n \n  <p>\n-Build a web application by following the <a href="/doc/codelab/wiki/">Wiki\n-Codelab</a>.\n+Build a web application by following the <a href="/doc/articles/wiki/">Wiki\n+Tutorial</a>.\n  </p>\n \n  <p>

doc/install.html

--- a/doc/install.html
+++ b/doc/install.html
@@ -153,8 +153,8 @@ read <a href="/doc/code.html">How to Write Go Code</a>.\n  </p>\n \n  <p>\n-Build a web application by following the <a href="/doc/codelab/wiki/">Wiki\n-Codelab</a>.\n+Build a web application by following the <a href="/doc/articles/wiki/">Wiki\n+Tutorial</a>.\n  </p>\n \n  <p>

コアとなるコードの解説

このコミットの主要な目的は、Go言語のドキュメント構造を改善し、特に「Writing Web Applications」というWikiチュートリアルの位置づけを明確にすることです。

ディレクトリのリネーム: doc/codelab/wiki から doc/articles/wiki へのリネームは、このチュートリアルがもはや単なる「コードラボ」という実践演習の枠に留まらず、より一般的な「記事」として提供されるべきであるという判断に基づいています。これにより、ドキュメントの分類がより論理的になり、ユーザーがGo言語に関する様々な情報（チュートリアル、解説、リファレンスなど）をより効率的に見つけられるようになります。
HTMLファイル内のメタデータとテキストの更新: index.html と wiki.html における変更は、コンテンツ自体の表現を新しいカテゴリに合わせるためのものです。
-  から  への変更は、HTMLコメント内に構造化されたメタデータを埋め込む標準的な方法への移行を示唆しています。これにより、ドキュメント生成ツールがページのタイトルをより確実に、かつプログラム的に抽出できるようになります。これは、ドキュメントサイトの自動生成やインデックス作成のプロセスを改善する上で重要です。
- 「Codelab」という単語を「tutorial」に置き換えることで、コンテンツが新しい「articles」カテゴリ内で「チュートリアル」として適切に表現されるようになります。これは、ユーザーがコンテンツの性質をより正確に理解するのに役立ちます。
ドキュメント内リンクの更新: docs.html、install-source.html、install.html の変更は、ドキュメントサイト全体の整合性を保つために不可欠です。チュートリアルのパスが変更されたため、既存のリンクを新しいパスに更新しないと、リンク切れが発生し、ユーザーエクスペリエンスが損なわれます。また、リンクテキストも「Wiki Codelab」から「Wiki Tutorial」に変更することで、サイト全体で一貫した用語が使用され、ユーザーの混乱を防ぎます。

これらの変更は全体として、Go言語の公式ドキュメントの品質とユーザビリティを向上させるための、細部にわたる配慮と継続的な改善努力を示しています。

参考にした情報源リンク

GitHubコミットページ: https://github.com/golang/go/commit/cd1a2f7e74b9a697cacfeee971cdba506b032eb2
Go言語の公式ドキュメント（現在の構造を理解するため）: https://go.dev/doc/
Gitの mv コマンドと similarity index についての一般的な情報 (例: Gitの公式ドキュメントやチュートリアル)
HTMLコメント内のメタデータに関する一般的なWeb開発の知識
Go言語のドキュメントの歴史に関する情報（必要に応じて）

comemo