Skip to content

Latest commit

 

History

History
153 lines (111 loc) · 9.62 KB

File metadata and controls

153 lines (111 loc) · 9.62 KB
PostgreSQL elephant logo

PostgreSQL Chinese Community

pgsql.cc · Explore PostgreSQL in Chinese

Localized website · Versioned manuals · Definition search · Extension catalog

简体中文 · English

Website Chinese manuals Django License

Visit the website → · Read the manuals · Search documentation · Browse extensions


pgsql.cc is a Chinese community website for PostgreSQL. Built on postgres/pgweb, it brings the content of postgresql.org and the PostgreSQL manuals to Chinese readers, with documentation search, an extension catalog, and a reading interface designed for Chinese content.

Founded and maintained by Ruohang Feng and the Pigsty team, the site operates as an independent community project with no organizational affiliation to the PostgreSQL Global Development Group (PGDG). See About pgsql.cc for content sources, translation details, and attribution.

What you can find

Versioned Chinese manuals

Chinese manuals for PostgreSQL 10–20, spanning archived releases, stable releases, beta versions, and development snapshots. Read online or download A4 / US Letter PDFs.

Open the manuals →

Search that finds definitions

Look up configuration parameters, SQL, functions, types, error codes, and tools by version. Search Chinese text, preview definitions, and jump to anchors; use / or ⌘K on wider screens.

Search documentation →

PostgreSQL extension catalog

Explore extension metadata from PGEXT, filter by category, license, programming language, or repository, and follow links to each extension's documentation and project.

Discover extensions →

Community and resources

Project information, news, events, release notes, download guides, and community resources follow the upstream information structure, retain source attribution, and add context for Chinese readers.

Visit the community homepage →

Try work_mem, pg18: pg_stat_activity, 23505, or ex: postgis. Manual definitions and extensions are searched in the site's PostgreSQL database; news and general pages use a separate site-wide full-text index.

Projects and content sources

Project Responsibility
pgsty/pgweb · this repository The Chinese website's Django applications, templates, styles, search, and content import tools
pgsty/pgdoc Versioned Chinese SGML manuals, translation style and terminology rules, and HTML / PDF builds
pgsty/pgext Authoritative extension metadata; this website synchronizes pgext.universe for catalog browsing and search
postgres/pgweb The upstream code for postgresql.org, on which this project's Chinese localization is based

Website content follows the corresponding upstream pages. Updates preserve existing translations, technical identifiers, code examples, and source links. Manuals are built in pgdoc, imported here, and then indexed for search. Third-party documentation for projects such as Patroni, PgBouncer, and pgBackRest is provided through curated external links, with the content maintained on the respective documentation sites.

Technology and layout

Layer Implementation
Application Python 3, Django 5.2, PostgreSQL
Interface Django templates, Bootstrap, project CSS / JavaScript, Font Awesome, and SVG icons
Documentation search PostgreSQL full-text search and pg_trgm, jieba Chinese segmentation, and extracted definition entries
Content maintenance Database migrations, manual imports, extension catalog synchronization, news and RSS tools
pgweb/
├── pgweb/       # Django apps: manuals, search, extensions, news, events, etc.
├── templates/   # Pages and components; general content in templates/pages/
├── media/       # CSS, JavaScript, images, and icons, served at /media/
├── data/        # Version-controlled configuration, including page metadata
├── tools/       # Content imports, synchronization, crawlers, and deployment
├── sql/         # Database helper functions and index definitions
└── docs/        # Development, content maintenance, and deployment guides

Files such as PDFs live in the local static/ directory and are served at /files/. Like local configuration, caches, and temporary reports, these files are excluded from Git and prepared through their respective workflows.

Local development

Prepare Python 3 and PostgreSQL, then follow the development installation guide to configure the database and dependencies:

git clone https://github.com/pgsty/pgweb.git
cd pgweb
python3 -m venv .venv
.venv/bin/python -m pip install -r requirements.txt

Set the local database, SECRET_KEY, DEBUG, SITE_ROOT, and local cookie options in pgweb/settings_local.py. Complete the migrations, helper SQL, and initial data setup described in the guide, then start the application:

.venv/bin/python manage.py check
.venv/bin/python manage.py runserver 127.0.0.1:8000

Open http://127.0.0.1:8000/. Manuals, extensions, news, and search results require their respective data imports and indexes; the guides below describe those workflows.

Maintenance guides

Task Documentation
Understand the application and frontend Architecture · Django · Frontend
Translate and review pages, maintain SEO Chinese content and SEO
Import Chinese manuals and PDFs Manual import and publication
Build and update the definition index Documentation search
Update the extension catalog Extension catalog and synchronization
Curate external ecosystem documentation Third-party documentation links
Configure the domain and deploy the website pgsql.cc deployment

The maintenance guides for the Chinese site are primarily written in Chinese; the inherited architecture and development guides are in English.

Contributing

Report translation errors, omissions, broken links, or functional issues through Issues, or submit a Pull Request. Include the page URL, reproduction steps, or corresponding upstream text so the change can be checked.

General content pages mostly live in templates/pages/. Submit manual translation changes to pgdoc, and maintain extension metadata at its PGEXT source. For improvements applicable to the upstream website, join the discussion on the pgsql-www mailing list.

Acknowledgments and license

Thanks to the PostgreSQL Global Development Group, upstream pgweb maintainers, and everyone contributing Chinese translations, reviews, and feedback. The website code retains the PostgreSQL License and its existing copyright and license notices. The PostgreSQL elephant SVG is reused from the repository's existing assets; third-party names, marks, and content belong to their respective owners.

Licenses of upstream components
Component License
Django BSD
Bootstrap MIT
Font Awesome Code: MIT; icons: CC BY 4.0; fonts: SIL OFL 1.1; see the licensing details
normalize.css MIT