docs: update logo + add docker for mac configuration note (#559)

This commit is contained in:
Rikin Kachhia 2018-09-27 21:34:21 +05:30 committed by Shahidh K Muhammed
parent d42f7b33da
commit e265086fa4
11 changed files with 142 additions and 17 deletions

View File

@ -1184,6 +1184,7 @@ ol, ul {
.mobile-logo-docs {
margin-left:10px;
padding-top: 10px;
text-decoration: none;
color: #333 !important;
}

View File

@ -52,7 +52,7 @@
<div class="mobile-logo mobile-only">
<a href="https://{{ BASE_DOMAIN }}/" target="_blank">
<div class="img_wrapper inline-block">
<img class="responsive logo_img no-shadow" src="{{ pathto('_images/layout/logo2.svg', 1) }}" />
<img class="responsive logo_img no-shadow" src="{{ pathto('_images/layout/logo-dark.svg', 1) }}" />
</div>
</a>
<a href="https://docs.{{ BASE_DOMAIN }}" class="docs_label mobile-logo-docs">DOCS&nbsp;&nbsp;v{{version}}</a>

View File

@ -2,7 +2,7 @@
<div class="header_main_logo inline-block mobile-hide">
<a href="https://{{ BASE_DOMAIN }}/" target="_blank">
<div class="img_wrapper inline-block">
<img class="responsive logo_img" src="{{ pathto('_images/layout/logo1.svg', 1) }}" />
<img class="responsive logo_img" src="{{ pathto('_images/layout/logo-lite.svg', 1) }}" />
</div>
</a>
<a class="docs_label" href="{{ pathto('', 1) }}">

View File

@ -235,7 +235,7 @@ html_theme_path = ["_theme"]
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
html_favicon = "img/layout/favicon.ico"
html_favicon = "img/layout/favicon.png"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,

View File

@ -13,18 +13,20 @@ Step 1: Get the docker run bash script
--------------------------------------
The `hasura/graphql-engine/install-manifests <https://github.com/hasura/graphql-engine/tree/master/install-manifests>`_ repo
contains all installation manifests required to deploy Hasura anywhere. Get the docker run bash script from there:
contains all installation manifests required to deploy Hasura anywhere.
Get the docker run bash script from there:
.. code-block:: bash
$ wget https://raw.githubusercontent.com/hasura/graphql-engine/master/install-manifests/docker-run/docker-run.sh
Step 2: Run the hasura docker container
---------------------------------------
Step 2: Configure the docker-run.sh script
------------------------------------------
Check the sample docker run command in ``docker-run.sh``.
Edit the ``--database-url`` flag command, so that you can connect to your Postgres instance.
Edit the ``--database-url`` flag value, so that you can connect to your Postgres instance.
.. code-block:: bash
:emphasize-lines: 5
@ -43,19 +45,41 @@ Examples of ``database-url``:
.. admonition:: Postgres on localhost
If your Postgres database is running on ``localhost``, add the ``--net=host`` flag to allow the Docker container to
access the host's network. This is what your command should look like:
.. rst-class:: api_tabs
.. tabs::
.. code-block:: bash
:emphasize-lines: 2
.. tab:: Linux
#! /bin/bash
docker run -d --net=host \
hasura/graphql-engine:latest \
graphql-engine \
--database-url postgres://username:password@hostname:port/dbname \
serve --enable-console
If your Postgres database is running on ``localhost``, add the ``--net=host`` flag to allow the Docker container to
access the host's network. This is what your command should look like:
.. code-block:: bash
:emphasize-lines: 2
#! /bin/bash
docker run -d --net=host \
hasura/graphql-engine:latest \
graphql-engine \
--database-url postgres://username:password@hostname:port/dbname \
serve --enable-console
.. tab:: Docker for Mac
If your Postgres database is running on ``localhost``, use ``host.docker.internal`` as hostname to access
the host's Postgres service. This is what your command should look like:
.. code-block:: bash
:emphasize-lines: 5
#! /bin/bash
docker run -d -p 8080:8080 \
hasura/graphql-engine:latest \
graphql-engine \
--database-url postgres://username:password@host.docker.internal:port/dbname \
serve --enable-console
Step 3: Run the hasura docker container
---------------------------------------
Execute ``docker-run.sh`` & check if everything is running well:

BIN
docs/img/layout/favicon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 KiB

View File

@ -0,0 +1,49 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 22.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 220 80" style="enable-background:new 0 0 220 80;" xml:space="preserve">
<style type="text/css">
.st0{fill:#102954;}
.st1{fill:#FFFFFF;}
</style>
<g>
<g>
<g>
<path class="st0" d="M67.4,26.8c2.1-5.2,2.2-16-0.7-24.4l0,0c-0.7-1.5-3-1.1-3.1,0.7v0.6c-0.5,7.9-3.4,12.2-7.6,14.2
c-0.7,0.3-1.8,0.2-2.5-0.2c-5.1-3.2-11-5.1-17.5-5.1s-12.4,1.9-17.5,5.1c-0.7,0.4-1.5,0.5-2.2,0.2C12,16.3,8.9,11.5,8.4,3.6V3.1
c0-1.6-2.3-2.1-3.1-0.7c-3,8.3-2.9,19.1-0.7,24.4c1.1,2.6,1.1,5.6,0.2,8.3c-1.2,3.4-1.8,7.2-1.7,11c0.3,17.4,15.1,32.2,32.4,32.4
c18.3,0.2,33.3-14.6,33.3-32.9c0-3.7-0.6-7.2-1.7-10.5C66.3,32.4,66.4,29.4,67.4,26.8z"/>
</g>
<ellipse class="st1" cx="36" cy="45.5" rx="25" ry="25"/>
<path class="st0" d="M39.9,42.9L34,33.8c-1-1.5-2.9-1.9-4.4-1c-0.9,0.6-1.5,1.6-1.5,2.7c0,0.6,0.2,1.2,0.6,1.7l4,6.2
c0.3,0.5,0.2,1.1-0.1,1.5l-6.2,6.8c-1.1,1.3-1.1,3.3,0.2,4.5c0.6,0.6,1.4,0.8,2.2,0.8c0.9,0,1.7-0.4,2.3-1.1l4.6-5.4
c0.3-0.4,1-0.4,1.3,0.1l3.3,4.7c0.2,0.3,0.5,0.7,0.9,1c1.1,0.8,2.5,0.7,3.5,0.1l0,0c0.9-0.6,1.5-1.6,1.5-2.7
c0-0.6-0.2-1.2-0.5-1.7L39.9,42.9z"/>
</g>
<g>
<path class="st0" d="M96.8,45.6h-3.9c-0.6,0-1.1-0.5-1.1-1.1V32.2c0-0.6-0.5-1.1-1.1-1.1h-3.4c-0.6,0-1.1,0.5-1.1,1.1v31.3
c0,0.6,0.5,1.1,1.1,1.1h3.4c0.6,0,1.1-0.5,1.1-1.1V51.3c0-0.6,0.5-1.1,1.1-1.1h3.9c0.6,0,1.1,0.5,1.1,1.1v12.2
c0,0.6,0.5,1.1,1.1,1.1h3.4c0.6,0,1.1-0.5,1.1-1.1V32.2c0-0.6-0.5-1.1-1.1-1.1H99c-0.6,0-1.1,0.5-1.1,1.1v12.3
C97.9,45.1,97.4,45.6,96.8,45.6z"/>
<path class="st0" d="M114.2,32l-5.5,31.3c-0.1,0.6,0.4,1.2,1,1.2h3.4c0.5,0,1-0.4,1-0.9l0.9-5.7c0.1-0.5,0.5-0.9,1-0.9h4.3
c0.5,0,1,0.4,1,0.9l1,5.8c0.1,0.5,0.5,0.9,1,0.9h3.5c0.7,0,1.2-0.6,1-1.3L122,32c-0.1-0.5-0.5-0.9-1-0.9h-5.8
C114.7,31.1,114.3,31.5,114.2,32z M119.3,52.3h-2.2c-0.7,0-1.1-0.6-1-1.2l1-11.5c0.2-1.2,1.9-1.2,2.1,0l1.1,11.5
C120.4,51.7,119.9,52.3,119.3,52.3z"/>
<path class="st0" d="M143,45.2h-3.8c-0.7,0-1.1-0.3-1.1-1.1v-7.2c0-0.7,0.4-1.1,1.1-1.1h2.2c0.7,0,1.1,0.3,1.1,1.1v3.4
c0,0.6,0.5,1.1,1.1,1.1h3.5c0.6,0,1.1-0.5,1.1-1.1v-4.2c0-3.3-1.8-5-5.3-5h-5.1c-3.5,0-5.3,1.7-5.3,5v8.6c0,3.3,1.8,5.1,5.2,5.1
h3.8c0.7,0,1.1,0.3,1.1,1.1v8c0,0.7-0.3,1.1-1.1,1.1h-2.2c-0.7,0-1.1-0.3-1.1-1.1v-3.4c0-0.6-0.5-1.1-1.1-1.1h-3.5
c-0.6,0-1.1,0.5-1.1,1.1v4.2c0,3.3,1.8,5,5.3,5h5c3.5,0,5.3-1.7,5.3-5v-9.4C148.2,46.9,146.4,45.2,143,45.2z"/>
<path class="st0" d="M164,58.8c0,0.7-0.3,1.1-1.1,1.1h-3c-0.7,0-1.1-0.3-1.1-1.1V32.2c0-0.6-0.5-1.1-1.1-1.1h-3.5
c-0.6,0-1.1,0.5-1.1,1.1v27.3c0,3.3,1.8,5,5.3,5h5.8c3.5,0,5.3-1.7,5.3-5V32.2c0-0.6-0.5-1.1-1.1-1.1h-3.3c-0.6,0-1.1,0.5-1.1,1.1
L164,58.8L164,58.8z"/>
<path class="st0" d="M191.8,46.3V36.1c0-3.3-1.8-5-5.3-5h-10c-0.6,0-1.1,0.5-1.1,1.1v31.3c0,0.6,0.5,1.1,1.1,1.1h3.4
c0.6,0,1.1-0.5,1.1-1.1v-11c0-0.6,0.5-1.1,1.1-1.1l0,0c0.4,0,0.8,0.3,1,0.7l4.4,11.8c0.2,0.4,0.6,0.7,1,0.7h3.7
c0.7,0,1.3-0.7,1-1.4L189,52.3c-0.2-0.5,0.1-1.1,0.6-1.4C190.9,50.1,191.8,48.5,191.8,46.3z M186.2,36.9v8.8
c0,0.7-0.4,1.1-1.1,1.1H182c-0.6,0-1.1-0.5-1.1-1.1v-8.8c0-0.6,0.5-1.1,1.1-1.1h3.1C185.8,35.8,186.2,36.2,186.2,36.9z"/>
<path class="st0" d="M210.2,31.1h-5.8c-0.5,0-1,0.4-1,0.9l-5.5,31.3c-0.1,0.6,0.4,1.2,1,1.2h3.4c0.5,0,1-0.4,1-0.9l0.9-5.7
c0.1-0.5,0.5-0.9,1-0.9h4.3c0.5,0,1,0.4,1,0.9l1,5.8c0.1,0.5,0.5,0.9,1,0.9h3.5c0.7,0,1.2-0.6,1-1.3L211.2,32
C211.1,31.5,210.7,31.1,210.2,31.1z M208.4,52.3h-2.1c-0.7,0-1.1-0.6-1-1.2l1-10.5c0.2-1.2,1.9-1.2,2.1,0l1.1,10.5
C209.6,51.7,209.1,52.3,208.4,52.3z"/>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 3.6 KiB

View File

@ -0,0 +1,51 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 22.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 270 80" style="enable-background:new 0 0 270 80;" xml:space="preserve">
<style type="text/css">
.st0{fill:#FFFFFF;}
</style>
<g id="Layer_2_1_">
</g>
<g id="Layer_1_5_">
<g>
<g>
<path class="st0" d="M110,45.5h-5.1c-0.8,0-1.4-0.7-1.4-1.4V28c0-0.8-0.7-1.4-1.4-1.4h-4.4c-0.8,0-1.4,0.7-1.4,1.4v40.7
c0,0.8,0.7,1.4,1.4,1.4h4.4c0.8,0,1.4-0.7,1.4-1.4V52.9c0-0.8,0.7-1.4,1.4-1.4h5.1c0.8,0,1.4,0.7,1.4,1.4v15.9
c0,0.8,0.7,1.4,1.4,1.4h4.4c0.8,0,1.4-0.7,1.4-1.4V28c0-0.8-0.7-1.4-1.4-1.4h-4.4c-0.8,0-1.4,0.7-1.4,1.4v16
C111.4,44.8,110.8,45.5,110,45.5z"/>
<path class="st0" d="M132.6,27.8l-7.2,40.7c-0.1,0.8,0.5,1.6,1.3,1.6h4.4c0.7,0,1.3-0.5,1.3-1.2l1.2-7.4c0.1-0.7,0.7-1.2,1.3-1.2
h5.6c0.7,0,1.3,0.5,1.3,1.2l1.3,7.5c0.1,0.7,0.7,1.2,1.3,1.2h4.6c0.9,0,1.6-0.8,1.3-1.7l-7.5-40.7c-0.1-0.7-0.7-1.2-1.3-1.2h-7.5
C133.3,26.6,132.8,27.1,132.6,27.8z M139.3,54.2h-2.9c-0.9,0-1.4-0.8-1.3-1.6l1.3-15c0.3-1.6,2.5-1.6,2.7,0l1.4,15
C140.7,53.4,140.1,54.2,139.3,54.2z"/>
<path class="st0" d="M170.1,44.9h-4.9c-0.9,0-1.4-0.4-1.4-1.4v-9.4c0-0.9,0.5-1.4,1.4-1.4h2.9c0.9,0,1.4,0.4,1.4,1.4v4.4
c0,0.8,0.7,1.4,1.4,1.4h4.6c0.8,0,1.4-0.7,1.4-1.4v-5.5c0-4.3-2.3-6.5-6.9-6.5h-6.6c-4.6,0-6.9,2.2-6.9,6.5v11.2
c0,4.3,2.3,6.6,6.8,6.6h4.9c0.9,0,1.4,0.4,1.4,1.4v10.4c0,0.9-0.4,1.4-1.4,1.4h-2.9c-0.9,0-1.4-0.4-1.4-1.4v-4.4
c0-0.8-0.7-1.4-1.4-1.4h-4.6c-0.8,0-1.4,0.7-1.4,1.4v5.5c0,4.3,2.3,6.5,6.9,6.5h6.5c4.6,0,6.9-2.2,6.9-6.5V51.6
C176.9,47.1,174.5,44.9,170.1,44.9z"/>
<path class="st0" d="M197.4,62.6c0,0.9-0.4,1.4-1.4,1.4h-3.9c-0.9,0-1.4-0.4-1.4-1.4V28c0-0.8-0.7-1.4-1.4-1.4h-4.6
c-0.8,0-1.4,0.7-1.4,1.4v35.5c0,4.3,2.3,6.5,6.9,6.5h7.5c4.6,0,6.9-2.2,6.9-6.5V28c0-0.8-0.7-1.4-1.4-1.4h-4.3
c-0.8,0-1.4,0.7-1.4,1.4L197.4,62.6L197.4,62.6z"/>
<path class="st0" d="M233.6,46.4V33.1c0-4.3-2.3-6.5-6.9-6.5h-13c-0.8,0-1.4,0.7-1.4,1.4v40.7c0,0.8,0.7,1.4,1.4,1.4h4.4
c0.8,0,1.4-0.7,1.4-1.4V54.4c0-0.8,0.7-1.4,1.4-1.4l0,0c0.5,0,1,0.4,1.3,0.9l5.7,15.3c0.3,0.5,0.8,0.9,1.3,0.9h4.8
c0.9,0,1.7-0.9,1.3-1.8l-5.5-14.2c-0.3-0.7,0.1-1.4,0.8-1.8C232.4,51.3,233.6,49.2,233.6,46.4z M226.3,34.1v11.4
c0,0.9-0.5,1.4-1.4,1.4h-4c-0.8,0-1.4-0.7-1.4-1.4V34.1c0-0.8,0.7-1.4,1.4-1.4h4C225.8,32.7,226.3,33.2,226.3,34.1z"/>
<path class="st0" d="M257.5,26.6H250c-0.7,0-1.3,0.5-1.3,1.2l-7.2,40.7c-0.1,0.8,0.5,1.6,1.3,1.6h4.4c0.7,0,1.3-0.5,1.3-1.2
l1.2-7.4c0.1-0.7,0.7-1.2,1.3-1.2h5.6c0.7,0,1.3,0.5,1.3,1.2l1.3,7.5c0.1,0.7,0.7,1.2,1.3,1.2h4.6c0.9,0,1.6-0.8,1.3-1.7
l-7.5-40.7C258.7,27.1,258.2,26.6,257.5,26.6z M255.2,54.2h-2.7c-0.9,0-1.4-0.8-1.3-1.6l1.3-13.7c0.3-1.6,2.5-1.6,2.7,0l1.4,13.7
C256.7,53.4,256.1,54.2,255.2,54.2z"/>
</g>
<g>
<path class="st0" d="M68.2,26.8c2.2-5.3,2.2-16.1-0.7-24.4l0,0c-0.8-1.5-3-1-3.1,0.6v0.6c-0.5,7.9-3.4,12.2-7.7,14.3
c-0.7,0.3-1.8,0.3-2.5-0.2c-5.1-3.2-11.1-5.1-17.6-5.1S24.1,14.5,19,17.7c-0.7,0.4-1.5,0.5-2.2,0.2c-4.4-1.6-7.4-6.4-7.9-14.4
V2.9C8.8,1.3,6.5,0.8,5.8,2.3C2.9,10.7,3,21.5,5.1,26.8c1.1,2.6,1.1,5.6,0.2,8.3c-1.2,3.4-1.8,7.2-1.7,11
C4,63.5,18.8,78.3,36.2,78.6c18.4,0.2,33.4-14.6,33.4-33c0-3.7-0.6-7.2-1.7-10.5C67,32.4,67.1,29.4,68.2,26.8z M36.2,70.7
c-13.4-0.3-24.4-11.2-24.6-24.6c-0.3-14.3,11.3-25.9,25.5-25.6c13.4,0.2,24.4,11.2,24.6,24.6C62,59.3,50.4,70.9,36.2,70.7z"/>
<path class="st0" d="M40.5,42.9l-5.9-9.1c-0.9-1.5-2.9-1.9-4.4-1c-0.9,0.6-1.5,1.6-1.5,2.7c0,0.6,0.2,1.2,0.5,1.7l4,6.2
c0.3,0.5,0.2,1.1-0.1,1.5l-6.2,6.8c-1.2,1.3-1.1,3.3,0.2,4.5c0.6,0.5,1.4,0.8,2.2,0.8c0.9,0,1.7-0.4,2.3-1l4.6-5.4
c0.4-0.4,1-0.4,1.3,0.1l3.3,4.7c0.2,0.4,0.5,0.7,0.9,0.9c1.1,0.8,2.5,0.8,3.6,0.1l0,0c0.9-0.6,1.5-1.6,1.5-2.7
c0-0.6-0.2-1.2-0.5-1.7L40.5,42.9z"/>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 3.8 KiB

View File

Before

Width:  |  Height:  |  Size: 361 KiB

After

Width:  |  Height:  |  Size: 361 KiB

View File

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 2.2 KiB

View File

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 2.2 KiB