Collapse index sections and improve the wording
This commit is contained in:
steve-chavez
committed by
Steve Chávez
Steve Chávez
parent
7805b99d57
commit
5942db7fa7
+16
-38
@@ -1,18 +1,3 @@
|
||||
.. _eco_external_notification:
|
||||
|
||||
External Notification
|
||||
---------------------
|
||||
|
||||
These are PostgreSQL bridges that propagate LISTEN/NOTIFY to external queues for further processing. This allows stored procedures to initiate actions outside the database such as sending emails.
|
||||
|
||||
* `diogob/postgres-websockets <https://github.com/diogob/postgres-websockets>`_ - expose web sockets for PostgreSQL's LISTEN/NOTIFY
|
||||
* `frafra/postgresql2websocket <https://github.com/frafra/postgresql2websocket>`_ - Websockets
|
||||
* `matthewmueller/pg-bridge <https://github.com/matthewmueller/pg-bridge>`_ - Amazon SNS
|
||||
* `aweber/pgsql-listen-exchange <https://github.com/aweber/pgsql-listen-exchange>`_ - RabbitMQ
|
||||
* `SpiderOak/skeeter <https://github.com/SpiderOak/skeeter>`_ - ZeroMQ
|
||||
* `FGRibreau/postgresql-to-amqp <https://github.com/FGRibreau/postgresql-to-amqp>`_ - AMQP
|
||||
* `daurnimator/pg-kinesis-bridge <https://github.com/daurnimator/pg-kinesis-bridge>`_ - Amazon Kinesis
|
||||
|
||||
.. _eco_example_apps:
|
||||
|
||||
Example Apps
|
||||
@@ -38,6 +23,22 @@ Example Apps
|
||||
* `PierreRochard/postgrest-boilerplate <https://github.com/PierreRochard/postgrest-boilerplate>`_ - example auth back-end
|
||||
* `marmelab/ng-admin-postgrest <https://github.com/marmelab/ng-admin-postgrest>`_ - automatic database admin panel
|
||||
|
||||
.. _eco_external_notification:
|
||||
|
||||
External Notification
|
||||
---------------------
|
||||
|
||||
These are PostgreSQL bridges that propagate LISTEN/NOTIFY to external queues for further processing. This allows stored procedures to initiate actions outside the database such as sending emails.
|
||||
|
||||
* `diogob/postgres-websockets <https://github.com/diogob/postgres-websockets>`_ - expose web sockets for PostgreSQL's LISTEN/NOTIFY
|
||||
* `frafra/postgresql2websocket <https://github.com/frafra/postgresql2websocket>`_ - Websockets
|
||||
* `matthewmueller/pg-bridge <https://github.com/matthewmueller/pg-bridge>`_ - Amazon SNS
|
||||
* `aweber/pgsql-listen-exchange <https://github.com/aweber/pgsql-listen-exchange>`_ - RabbitMQ
|
||||
* `SpiderOak/skeeter <https://github.com/SpiderOak/skeeter>`_ - ZeroMQ
|
||||
* `FGRibreau/postgresql-to-amqp <https://github.com/FGRibreau/postgresql-to-amqp>`_ - AMQP
|
||||
* `daurnimator/pg-kinesis-bridge <https://github.com/daurnimator/pg-kinesis-bridge>`_ - Amazon Kinesis
|
||||
|
||||
|
||||
.. _eco_extensions:
|
||||
|
||||
Extensions
|
||||
@@ -77,26 +78,3 @@ Commercial
|
||||
---------------
|
||||
|
||||
* `subZero <https://subzero.cloud/>`_ - Automated GraphQL & REST API with built-in caching (powered in part by PostgREST)
|
||||
|
||||
.. _eco_production:
|
||||
|
||||
In Production
|
||||
-------------
|
||||
|
||||
* `Moat <https://moat.com/>`_
|
||||
* `Catarse <https://www.catarse.me/>`_
|
||||
* `Redsmin <https://www.redsmin.com/>`_
|
||||
* `Image-charts <https://image-charts.com/>`_
|
||||
* `MotionDynamic - Fast highly dynamic video generation at scale <https://api.motiondynamic.tech/>`_
|
||||
* `Drip Depot <https://www.dripdepot.com/>`_
|
||||
* `Convene <https://info.convene.thomsonreuters.com/en.html>`_ by Thomson-Reuters
|
||||
* `eGull <http://www.egull.co>`_
|
||||
* `Elyios <https://elyios.com>`_
|
||||
* `Simply Connected Systems <https://www.simplyconnectedsystems.com/>`_
|
||||
* `Nimbus <https://nimbusforwork.com/>`_
|
||||
|
||||
- See how Nimbus uses PostgREST in `Paul Copplestone's blog post <https://paul.copplest.one/blog/nimbus-tech-2019-04.html#products>`_.
|
||||
* `Datrium <https://www.datrium.com>`_
|
||||
|
||||
.. * `OpenBooking <http://openbooking.ch>`_
|
||||
.. * `triggerFS - A realtime messaging and distributed trigger system <https://triggerfs.io/>`_
|
||||
|
||||
@@ -74,7 +74,7 @@ The project has a friendly and growing community. Join our `chat room <https://g
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
Start here if you're new to PostgREST.
|
||||
Are you new to PostgREST? This is the place to start!
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
@@ -86,10 +86,12 @@ Start here if you're new to PostgREST.
|
||||
- :doc:`tutorials/tut0`
|
||||
- :doc:`tutorials/tut1`
|
||||
|
||||
Also have a look at :doc:`Installation <install>`.
|
||||
|
||||
How-to guides
|
||||
-------------
|
||||
|
||||
Goal-oriented guides that show how to solve a specific problem.
|
||||
These are recipes that'll help you address specific use-cases.
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
@@ -104,19 +106,23 @@ Goal-oriented guides that show how to solve a specific problem.
|
||||
Reference guides
|
||||
----------------
|
||||
|
||||
Technical references for PostgREST's API and Configuration.
|
||||
Technical references for PostgREST's functionality.
|
||||
|
||||
.. toctree::
|
||||
:caption: API
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
api.rst
|
||||
|
||||
.. toctree::
|
||||
:caption: Configuration
|
||||
:hidden:
|
||||
|
||||
configuration.rst
|
||||
|
||||
- :doc:`API <api>`
|
||||
- :doc:`configuration`
|
||||
|
||||
Topic guides
|
||||
------------
|
||||
|
||||
@@ -124,26 +130,30 @@ Explanations of some key concepts in PostgREST.
|
||||
|
||||
.. toctree::
|
||||
:caption: Authentication
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
auth.rst
|
||||
|
||||
.. toctree::
|
||||
:caption: Installation
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
install.rst
|
||||
|
||||
.. toctree::
|
||||
:caption: Administration
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
admin.rst
|
||||
|
||||
- :doc:`Authentication <auth>`
|
||||
- :doc:`Installation <install>`
|
||||
- :doc:`Administration <admin>`
|
||||
|
||||
Ecosystem
|
||||
---------
|
||||
|
||||
PostgREST has a growing ecosystem of examples, and libraries, experiments, and users. Here is a selection.
|
||||
PostgREST has a growing ecosystem of examples, libraries, and experiments. Here is a selection.
|
||||
|
||||
.. toctree::
|
||||
:caption: Ecosystem
|
||||
@@ -151,30 +161,33 @@ PostgREST has a growing ecosystem of examples, and libraries, experiments, and u
|
||||
|
||||
ecosystem.rst
|
||||
|
||||
* :ref:`eco_external_notification`
|
||||
* :ref:`eco_example_apps`
|
||||
* :ref:`eco_external_notification`
|
||||
* :ref:`eco_extensions`
|
||||
* :ref:`clientside_libraries`
|
||||
* :ref:`eco_commercial`
|
||||
* :ref:`eco_production`
|
||||
|
||||
.. _supporting-dev:
|
||||
In Production
|
||||
-------------
|
||||
|
||||
Supporting development
|
||||
----------------------
|
||||
Here are some companies that use PostgREST in production.
|
||||
|
||||
You can help PostgREST ongoing maintenance and development by:
|
||||
* `Datrium <https://www.datrium.com>`_
|
||||
* `Nimbus <https://nimbusforwork.com/>`_
|
||||
- See how Nimbus uses PostgREST in `Paul Copplestone's blog post <https://paul.copplest.one/blog/nimbus-tech-2019-04.html#products>`_.
|
||||
* `Catarse <https://www.catarse.me/>`_
|
||||
* `Moat <https://moat.com/>`_
|
||||
* `Redsmin <https://www.redsmin.com/>`_
|
||||
* `Image-charts <https://image-charts.com/>`_
|
||||
* `MotionDynamic - Fast highly dynamic video generation at scale <https://api.motiondynamic.tech/>`_
|
||||
* `Drip Depot <https://www.dripdepot.com/>`_
|
||||
* `Convene <https://info.convene.thomsonreuters.com/en.html>`_ by Thomson-Reuters
|
||||
* `eGull <http://www.egull.co>`_
|
||||
* `Elyios <https://elyios.com>`_
|
||||
* `Simply Connected Systems <https://www.simplyconnectedsystems.com/>`_
|
||||
|
||||
- Making a regular donation through `Patreon <https://www.patreon.com/postgrest>`_
|
||||
|
||||
- Alternatively, you can make a one-time donation via `Paypal <https://www.paypal.me/postgrest>`_
|
||||
|
||||
Every donation will be spent on making PostgREST better for the whole community.
|
||||
|
||||
Translations
|
||||
------------
|
||||
|
||||
* `Chinese <http://postgrest.org/zh/latest/>`_ (latest version ``v0.4.2.0``)
|
||||
.. * `OpenBooking <http://openbooking.ch>`_
|
||||
.. * `triggerFS - A realtime messaging and distributed trigger system <https://triggerfs.io/>`_
|
||||
|
||||
Testimonials
|
||||
------------
|
||||
@@ -215,3 +228,8 @@ Testimonials
|
||||
Couldn't be happier."
|
||||
|
||||
-- Anupam Garg, Datrium, Inc.
|
||||
|
||||
Translations
|
||||
------------
|
||||
|
||||
* `Chinese <http://postgrest.org/zh/latest/>`_ (latest version ``v0.4.2.0``)
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
Release Notes
|
||||
=============
|
||||
|
||||
Here we'll include the most relevant changes so you can migrate to newer versions easily.
|
||||
You can see the full changelog of each release in the `PostgREST repository <https://github.com/PostgREST/postgrest/releases>`_.
|
||||
|
||||
v5.2.0
|
||||
======
|
||||
|
||||
* `Explicit qualification <http://postgrest.org/en/v5.0/api.html#explicit-qualification>`_ introduced in ``v5.0`` is no longer necessary, this section will not be included from this version onwards. A :ref:`db-extra-search-path` configuration parameter was introduced to avoid the need to explictly qualify database objects. If you install PostgreSQL extensions on the ``public`` schema, they'll work normally from now on.
|
||||
|
||||
* Now you can filter :ref:`tabs-cols-w-spaces`.
|
||||
|
||||
* Included the ability to quote columns that have :ref:`reserved-chars`.
|
||||
|
||||
* Thanks to `Zhou Feng <https://github.com/zhoufeng1989>`_, now is possible to reference an external file in :ref:`db-uri`.
|
||||
|
||||
* Thanks to `Russell Davies <https://github.com/russelldavies>`_, Json Web Key Sets are now accepted by :ref:`jwt-secret`.
|
||||
|
||||
Thanks
|
||||
------
|
||||
|
||||
This release was made possible thanks to:
|
||||
|
||||
* `Daniel Babiak <https://github.com/d-babiak>`_
|
||||
* `Michel Pelletier <https://github.com/michelp>`_
|
||||
* Tsingson Qin
|
||||
* Jay Hannah
|
||||
* Victor Adossi
|
||||
* Petr Beles
|
||||
|
||||
If you like to join them please consider :ref:`supporting PostgREST development <supporting-dev>`.
|
||||
|
||||
Reference in New Issue
Block a user