このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- PostgreSQL
- テクニカル ライター:
- lu
- プロジェクト名:
- 入門チュートリアル
- プロジェクトの長さ:
- 標準の期間(3 か月)
プロジェクトの説明
初心者向けの PostgreSQL のインストールと設定を改善するために、入門チュートリアルを更新しました。(https://www.postgresql.org/docs/current/tutorial-start.html)
「アーキテクチャの基礎」の章を、PostgreSQL チュートリアルの包括的な概要に変更します(https://www.postgresql.org/docs/current/tutorial-arch.html)。拡張できる対象は、クライアント サーバー アーキテクチャ、このチュートリアルで使用するクライアントの例として psql、PostgreSQL コンテキストにおける「クラスタ」用語、DB ユーザーと OS ユーザー、所有権です。
インストール チュートリアルを更新しました(https://www.postgresql.org/docs/current/tutorial-install.html)。
- ソースとバイナリの両方のインストール オプションを宣伝します。最小限のバイナリ インストール手順を提供する https://www.postgresql.org/download/ への参照を追加しました。
- バイナリ インストール手順に不足がある場合は、ウェブサイトを拡張するか、ドキュメントで不足を補います。
- ユーザーがソースのインストール チャプターをすべて読んで理解してくれることを期待しないでください。クラスタの初期化やサーバーの(自動)起動など、インストール後に必要な主な手順の概要を説明します。必要に応じて、詳細が記載された特定のドキュメントの章へのリンクを提供します。
- コミュニティで認識されているものがあれば、特定の OS のデフォルトとベスト プラクティスに関する関連リソースへの [参照] リンクも追加します。
https://www.postgresql.org/docs/current/tutorial-createdb.html の改善
- 可能な限り「管理者に問い合わせる」という指示を削除し、ユーザーがチュートリアルの手順に沿って操作したと仮定して、実用的な解決策を提供します。
https://www.postgresql.org/docs/current/tutorial-accessdb.html を改善します。
- 認証に関連する基本的な問題と簡単な pg_hba.conf の例について説明する
このドキュメント パッチを提供するには、Windows と Ubuntu に関する現在のチュートリアルを試し、セットアップに関するよくある問題に関するフォーラムを閲覧し、メンターに相談してベスト プラクティスを正しく理解し、最も重要なコンセプトが過度に単純化されていない説明になるようにします。