Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update the net.box tutorial #4054

Merged
merged 7 commits into from
Mar 12, 2024
Merged

Update the net.box tutorial #4054

merged 7 commits into from
Mar 12, 2024

Conversation

andreyaksenov
Copy link
Contributor

@andreyaksenov andreyaksenov commented Feb 20, 2024 •
edited
Loading

Below are the changes related to updating the net.box tutorial to using a new configuration approach. Staging: Getting started with net.box.

  • Created the sample_db application that can be used to demonstrate remote connections to Tarantool. This example is going to be reused in the upcoming tutorials for other connectors to simplify the maintenance of these samples and for consistency.
  • Created the net_box sample that contains examples of net.box requests to the sample_db database.
  • Included code snippets from new samples to the Getting started with net.box tutorial.

Related changes:

@andreyaksenov andreyaksenov linked an issue Feb 20, 2024 that may be closed by this pull request
[Config] Update the 'Getting started with net.box' topic to using a new config #3921
Closed
@andreyaksenov andreyaksenov force-pushed the update-net-box-tutorial branch 2 times, most recently from 4807e18 to d83023f Compare February 20, 2024 14:30
@andreyaksenov andreyaksenov force-pushed the update-net-box-tutorial branch 15 times, most recently from d7a06a2 to 5606ef5 Compare March 4, 2024 14:35
@andreyaksenov andreyaksenov marked this pull request as ready for review March 4, 2024 14:36
@andreyaksenov andreyaksenov force-pushed the update-net-box-tutorial branch 5 times, most recently from 4f9d100 to 16bd4cc Compare March 5, 2024 07:09
@Totktonada
Copy link
Member

We discussed the new tutorial with @andreyaksenov and agreed that the net_box application is not necessary to show how a net.box connection works. Andrey agreed to rewrite the tutorial with idea to use the interactive console for the net.box requests.

@andreyaksenov andreyaksenov force-pushed the update-net-box-tutorial branch 3 times, most recently from 1488da3 to 5e519b7 Compare March 6, 2024 13:50
Totktonada
Totktonada approved these changes Mar 6, 2024
View reviewed changes
Copy link
Member

@Totktonada Totktonada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've looked on the tutorial itself and it looks OK for me. Thanks!

I didn't look on the updates on the other pages. Let me know if it is important.

@andreyaksenov andreyaksenov requested a review from xuniq March 6, 2024 15:07
@andreyaksenov andreyaksenov force-pushed the update-net-box-tutorial branch 2 times, most recently from 824f16d to 88aa224 Compare March 7, 2024 08:42
@andreyaksenov andreyaksenov mentioned this pull request Mar 7, 2024
Closed
xuniq
xuniq approved these changes Mar 12, 2024
View reviewed changes
doc/how-to/getting_started_db.rst Outdated

Installing Tarantool
--------------------
In this tutorial, you create a Tarantool database, write data to and select data from this database.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In this tutorial, you create a Tarantool database, write data to and select data from this database.
In this tutorial, you create a Tarantool database, write data to it, and select data from this database.

doc/how-to/getting_started_db.rst Outdated
Comment on lines 18 to 19
* :ref:`Install the tt <tt-installation>` utility.
* `Install tarantool <https://www.tarantool.io/en/download/os-installation/>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* :ref:`Install the tt <tt-installation>` utility.
* `Install tarantool <https://www.tarantool.io/en/download/os-installation/>`_.
* Install the :ref:`tt <tt-installation>` utility.
* Install `Tarantool <https://www.tarantool.io/en/download/os-installation/>`_.

doc/how-to/getting_started_net_box.rst Outdated

First, load the ``net.box`` module with the ``require('net.box')`` method:
To try out ``net.box`` requests in the interactive console, you need to start the :ref:`sample_db <getting_started_net_box_sample_db>` application using ``tt start``:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To try out ``net.box`` requests in the interactive console, you need to start the :ref:`sample_db <getting_started_net_box_sample_db>` application using ``tt start``:
To try out ``net.box`` requests in the interactive console, start the :ref:`sample_db <getting_started_net_box_sample_db>` application using ``tt start``:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, reference link might be useful (tt start)

doc/how-to/getting_started_net_box.rst Outdated

.. code-block:: tarantoolsession
To create a connection, pass a database URI to the ``connect()`` method:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, add the corresponding reference links for the netbox methods (connect(), ping(), etc).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for space_object.* functions

@andreyaksenov andreyaksenov merged commit 16ccbe2 into latest Mar 12, 2024
1 check failed
@andreyaksenov andreyaksenov deleted the update-net-box-tutorial branch March 12, 2024 15:18
p7nov pushed a commit that referenced this pull request Apr 4, 2024
@andreyaksenov @p7nov
Update the net.box tutorial (#4054)
e3f4ede
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Totktonada Totktonada Totktonada approved these changes

@xuniq xuniq xuniq approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Config] Update the 'Getting started with net.box' topic to using a new config
3 participants
@andreyaksenov @Totktonada @xuniq