PostgreSQL プロジェクト

このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。

プロジェクトの概要

オープンソースの組織:
PostgreSQL
テクニカル ライター:
lu
プロジェクト名:
入門チュートリアル
プロジェクトの期間:
標準の期間(3 か月)

プロジェクトの説明

初心者向けに PostgreSQL のインストールと設定を改善するための入門チュートリアルを更新しました。(https://www.postgresql.org/docs/current/tutorial-start.html)

  1. アーキテクチャの基礎の章を PostgreSQL チュートリアルの包括的な概要に変換してください(https://www.postgresql.org/docs/current/tutorial-arch.html)。拡張できる可能性があるのは、クライアント サーバー アーキテクチャ、このチュートリアルで使用するクライアントの例としての psql、PostgreSQL のコンテキストにおける「クラスタ」用語、DB と OS のユーザーと所有権です。

  2. アップデートのインストールのチュートリアル(https://www.postgresql.org/docs/current/tutorial-install.html

    • ソースとバイナリの両方のインストール オプションをアドバタイズします。最小限のバイナリ インストール手順を提供する https://www.postgresql.org/download/ への参照を追加します。
    • バイナリ インストール手順にギャップがある場合は特定し、ウェブサイトを拡張するか、ドキュメントで対処します。
    • クラスタの初期化やサーバーの(自動)起動など、インストール後に必要となる主な手順について、ユーザーにソース インストールの章の全文を読んでもらう必要はありません。該当する場合は、ドキュメントの特定の章へのリンクで詳細を記載します。
    • コミュニティで認識されている特定の OS のデフォルトやベスト プラクティスについて詳しく説明した関連リソースへのリンクも追加します。
  3. https://www.postgresql.org/docs/current/tutorial-createdb.html を改善する

    • 「管理者に問い合わせる」の手順は可能な限り避け、ユーザーがチュートリアルを一つひとつ進めたという前提に基づいて、実用的な解決策を提供する。
  4. https://www.postgresql.org/docs/current/tutorial-accessdb.html を改善する

    • 認証に関連する基本的な問題と簡単な pg_hba.conf の例について説明する

このドキュメント パッチを提供するにあたり、Windows と Ubuntu に関する現在のチュートリアルを試したり、設定に関する問題が頻発するフォーラムを確認したり、メンターに相談してベスト プラクティスを正しく理解したり、特に重要なコンセプトを過度に簡単に説明したりできるようにしたりするつもりです。