README.rst

   1 The PostgreSQL website
   2 ======================
   3
   4 The code in this repository is what backs the website at www.postgresql.org.
   5
   6 The authoritative repository for this code is on git.postgresql.org, but it's
   7 free to be mirrored anywhere.
   8
   9 Technology
  10 ----------
  11 The website code is written in `Python <https://www.python.org>`_ using
  12 the `Django <https://www.djangoproject.com/>`_ framework. Not surprisingly,
  13 `PostgreSQL <https://www.postgresql.org>`_ is used as the database. Further details
  14 about the code and technology can be found in the different documents in the
  15 docs directory.
  16
  17 The website also uses the `Bootstrap <https://getbootstrap.com/>`_ CSS framework
  18 as well as the `Font Awesome <https://fontawesome.com/>`_ icon library.
  19
  20 Content
  21 -------
  22 A fair amount of the content pages of the website are just static HTML templates.
  23 If you wish to edit these, you only need to look at the templates/pages/
  24 subdirectory. The content in here is simple HTML, and can be edited as such.
  25
  26 Contributing
  27 ------------
  28 We appreciate all (most?) contributions to this project. If you wish to
  29 contribute, be sure to sign up to the `pgsql-www <https://www.postgresql.org/list/>`_
  30 mailinglist for any discussions, and post any suggested patches there. If you
  31 want to make any major changes, be sure to have discussed those on the list first.
  32
  33 Setting up a local instance
  34 +++++++++++++++++++++++++++
  35 To set up a local instance for testing or building patches, please see the
  36 `docs/dev_install.rst <docs/dev_install.rst>`_ document.
  37
  38 Licence
  39 -------
  40 The code for the website is licensed under
  41 `The PostgreSQL Licence <https://www.opensource.org/licenses/postgresql>`_, which is
  42 closely related to the BSD licence.
  43
  44 Django is released under its `BSD Licence <https://github.com/django/django/blob/master/LICENSE>`_.
  45
  46 Bootstrap is released under the `MIT Licence <https://github.com/twbs/bootstrap/blob/master/LICENSE>`_.
  47 and includes the following software as well:
  48
  49 - jQuery under the `MIT Licence <https://jquery.org/license/>`_
  50 - Popper under the `MIT Licence <https://github.com/FezVrasta/popper.js/blob/master/LICENSE.md>`_
  51
  52 Font Awesome has a `combination of licences <https://fontawesome.com/license>`_:
  53
  54 The code of Font Awesome is released under the `MIT Licence <https://opensource.org/licenses/MIT>`_.
  55 The icons of Font Awesome are released under the `CC BY 4.0 Licence <https://creativecommons.org/licenses/by/4.0/>`_.
  56 The fonts of Font Awesome are released under the `SIL OFL 1.1 License <http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL>`_.
  57
  58 normalize.css uses the `MIT License <https://github.com/necolas/normalize.css/blob/master/LICENSE.md>`_