Skip to content

Sphinx panels #2472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 11 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
89 changes: 85 additions & 4 deletions doc/getting_started/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,96 @@
.. _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.

.. panels::
:container: doc-cards
:column: doc-card doc-card_big
:card: doc-card__content
:header: doc-card__title
:body: doc-card__text

.. link-button:: ./getting_started_db/#using-a-docker-image
:type: url
:text: Starting with Docker
:classes: doc-card__link

^^^

Create your first Tarantool project with a Docker image

---

.. link-button:: ./getting_started_db/#using-a-package-manager
:type: url
:text: Starting with a package manager
:classes: doc-card__link

^^^

Create your first Tarantool project with a package manager

---

.. link-button:: ./getting_started/getting_started_python/
:type: url
:text: Connect from Python
:classes: doc-card__link

^^^

Use the Python connector (tarantool/tarantool-python) to work with Tarantool

---

.. link-button:: ./getting_started/getting_started_python/
:type: url
:text: Connect from Python
:classes: doc-card__link

^^^

Use the PHP connector (tarantool/client) to work with Tarantool

---

.. link-button:: ./getting_started/getting_started_php/
:type: url
:text: Connect from PHP
:classes: doc-card__link

^^^

Use the Go connector (tarantool/go-tarantool) to work with Tarantool

---

.. link-button:: ./getting_started/getting_started_cxx/
:type: url
:text: Connect from C++
:classes: doc-card__link

^^^

Use the C++ connector (tarantool/tntcxx) to work with Tarantool

---

.. link-button:: ./getting_started/getting_started_cartridge/
:type: url
:text: Starting with Tarantool Cartridge
:classes: doc-card__link

^^^

Create your first Tarantool Cartridge application


.. toctree::
:maxdepth: 2
:numbered: 0
:hidden:

getting_started_db
getting_started_connectors
Expand Down
Loading