Skip to content

Commit

Permalink
Use sphinx-panels
Browse files Browse the repository at this point in the history
  • Loading branch information
NickVolynkin committed Nov 29, 2021
1 parent 93f9d96 commit b196c1c
Show file tree
Hide file tree
Showing 8 changed files with 169 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
jobs:
deploy-branch:
runs-on: ubuntu-latest
container: tarantool/doc-builder:fat-2
container: tarantool/doc-builder:fat-2.1
env:
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-custom.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ on:
jobs:
custom-deploy-branch:
runs-on: ubuntu-latest
container: tarantool/doc-builder:fat-2
container: tarantool/doc-builder:fat-2.1
env:
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
jobs:
deploy:
runs-on: ubuntu-latest
container: tarantool/doc-builder:fat-2
container: tarantool/doc-builder:fat-2.1
env:
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pull-translation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:
jobs:
pull-translations:
runs-on: ubuntu-latest
container: tarantool/doc-builder:fat-2
container: tarantool/doc-builder:fat-2.1

steps:
- uses: actions/checkout@v2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/push-translation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
jobs:
push-translation-sources:
runs-on: ubuntu-latest
container: tarantool/doc-builder:fat-2
container: tarantool/doc-builder:fat-2.1
steps:
- uses: actions/checkout@v2

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update-pot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:
jobs:
update-translations:
runs-on: ubuntu-latest
container: tarantool/doc-builder:fat-2
container: tarantool/doc-builder:fat-2.1

steps:

Expand Down
1 change: 1 addition & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
'sphinx.ext.intersphinx',
'sphinx.ext.extlinks',
'sphinxcontrib.plantuml',
'sphinx_panels',
'ext.custom',
'ext.LuaDomain',
'ext.LuaLexer',
Expand Down
162 changes: 162 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,168 @@
Tarantool - Documentation
-------------------------------------------------------------------------------

This manual embraces all aspects of using Tarantool:
from introductory information and exercises for beginners --- to advanced instructions
and detailed references for power users and contributors.


.. panels::
:container: doc-cards
:column: doc-card doc-card_medium
:card: doc-card__content
:header: doc-card__title
:body: doc-card__text
:footer: doc-card__link

:column: doc-card doc-card_getting-started
Getting Started

^^^

In this chapter, we show how to work with Tarantool as a DBMS ---
and how to connect to a Tarantool database from other programming languages.

+++

:doc:`Create your first Tarantool database </getting_started/getting_started_db>`

---

Application server

^^^

Working with Tarantool as a Lua application server.

---

Data model

^^^

How Tarantool stores values and what operations with data it supports.

---

Administration

^^^

How to administer Tarantool instances using ``systemd`` and ``tarantoolctl`` utilities.

---

CRUD operations

^^^

How the create, read, update and delete operations are implemented in Tarantool.


Main page example
-----------------


.. panels::
:container: doc-cards
:column: doc-card doc-card_small
:card: doc-card__content
:header: doc-card__logo
:body: doc-card__title
:footer: doc-card__text


:column: doc-card doc-card_getting-started
Getting Started

^^^

In this chapter, we show how to work with Tarantool as a DBMS ---
and how to connect to a Tarantool database from other programming languages.

+++

:doc:`Create your first Tarantool database </getting_started/getting_started_db>`

---

[img]

^^^

Tarantool Community Edition

+++

In-memory computing platform

---

[img]

^^^

Tarantool Data Grid

+++

Enterprise data services with ease.

---


[img]

^^^

Tarantool Enterprise

+++

Enterprise data services with ease.

---


[img]

^^^

Tarantool Cartridge

+++

Enterprise data services with ease.

---


[img]

^^^

Drivers

+++

Enterprise data services with ease.

---


[img]

^^^

Tools

+++

Enterprise data services with ease.

---


.. wp_section::
:class: documentation-main-page-header

Expand Down

0 comments on commit b196c1c

Please sign in to comment.