Wolfgang WaltherandWolfgang Walther
f33bccbcdb
Some users connect PostgREST to the wrong PostgreSQL instance - likely because they are not even aware that another instance is running. By using the standard port 5432 instead of 5433, we avoid this problem. The user will be made aware very early that they have another postgresql instance running - and can solve the problem at this stage. If they decide to change the port, they are much more likely to remember that in the later stages of the tutorial, too. Resolves https://github.com/PostgREST/postgrest-docs/issues/304
PostgREST documentation https://postgrest.org/
PostgREST docs use the reStructuredText format, check this cheatsheet to get acquainted with it.
To build the docs locally, see the Nix development readme.
Documentation structure
This documentation is structured according to tutorials-howtos-topics-references. For more details on the rationale of this structure, see https://www.divio.com/blog/documentation.
Translating
To create .po files for translation into a new language pass the language code as the first argument to postgrest-docs-build.
Example to add German/de:
postgrest-docs-build de
The livereload server also supports a language/locale argument to show the translated docs during translation:
postgrest-docs-serve de
Spellcheck is currently only available for the default language.