Skip to content

Add links to rock docs #3159

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

Merged
merged 3 commits into from
Sep 21, 2022
Merged
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
171 changes: 0 additions & 171 deletions doc/book/replication/repl_sync.rst

This file was deleted.

1 change: 1 addition & 0 deletions doc/dev_guide/internals/replication/orphan.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _internals-replication-orphan_status:
.. _replication-orphan_status:

Orphan status
=============
Expand Down
6 changes: 3 additions & 3 deletions doc/reference/reference_lua/datetime/datetime_object.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _datetime_object:
.. _datetime_obj:

datetime_object
===============
Expand Down Expand Up @@ -249,7 +249,7 @@ datetime_object

Modify an existing datetime object by adding values of the input argument.

:param table input: an :ref:`interval object <interval-new>` or an equivalent table (see **Example #1**)
:param table input: an :ref:`interval object <interval_obj>` or an equivalent table (see **Example #1**)
:param string adjust: defines how to round days in a month after an arithmetic operation.
Possible values: ``none``, ``last``, ``excess`` (see **Example #2**). Defaults to ``none``.

Expand Down Expand Up @@ -340,7 +340,7 @@ datetime_object

Modify an existing datetime object by subtracting values of the input argument.

:param table input: an :ref:`interval object <interval-new>` or an equivalent table (see **Example**)
:param table input: an :ref:`interval object <interval_obj>` or an equivalent table (see **Example**)
:param string adjust: defines how to round days in a month after an arithmetic operation.
Possible values: ``none``, ``last``, ``excess``. Defaults to ``none``.
The logic is similar to the one of the ``:add()`` method -- see :ref:`Example #2 <datetime-add-example2>`.
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/reference_lua/datetime/interval_object.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _inverval_object:
.. _interval_obj:

inverval_object
interval_object
===============

.. class:: interval_object
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/reference_lua/datetime/new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ datetime.new()
:param table units: Table of :ref:`time units <datetime-new-args>`.
If an empty table or no arguments are passed, the ``datetime`` object with the default values corresponding to Unix Epoch is created: ``1970-01-01T00:00:00Z``.

:return: :doc:`datetime object <./datetime/datetime_object>`
:return: :ref:`datetime object <datetime_obj>`
:rtype: cdata

.. _datetime-new-args:
Expand Down
6 changes: 0 additions & 6 deletions doc/reference/reference_rock/expirationd.rst

This file was deleted.

19 changes: 11 additions & 8 deletions doc/reference/reference_rock/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
:noindex:
:fullwidth:

================================================================================
Rocks reference
================================================================================
===============

This reference covers third-party Lua modules for Tarantool.

.. toctree::
:maxdepth: 2
.. toctree::
:maxdepth: 1

dbms
expirationd
../../book/cartridge/index
membership
Module metrics <../../book/monitoring/index>
Module luatest <luatest/luatest_overview>
vshard/index
../../book/cartridge/index
luatest/luatest_overview
dbms
other

For Tarantool Enterprise modules, see the
`Tarantool Enterprise documentation <https://www.tarantool.io/en/enterprise_doc/rocksref/>`_.
14 changes: 14 additions & 0 deletions doc/reference/reference_rock/other.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Other rocks
===========

This page features a list of links to third-party Tarantool module documentation
that is hosted externally -- mostly on GitHub pages or in READMEs:

* `checks <https://github.com/tarantool/checks/#readme>`_
* `crud <https://github.com/tarantool/crud#readme>`_
* `expirationd <https://tarantool.github.io/expirationd/>`_
* `icu-date <https://github.com/tarantool/icu-date#readme>`_
* `tracing <https://github.com/tarantool/tracing/>`_

For Tarantool Enterprise modules, see the
`Tarantool Enterprise documentation <https://www.tarantool.io/en/enterprise_doc/rocksref/>`_.
2 changes: 1 addition & 1 deletion doc/release/1.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Incompatible changes:
Please update your client libraries if you plan to use these new features
(:tarantool-issue:`2802`).
* :ref:`fiber_name() <fiber_object-name_get>` now raises an exception instead of truncating long fiber names.
We found that some Lua modules such as :ref:`expirationd <expirationd-module>` use ``fiber.name()``
We found that some Lua modules such as `expirationd <https://tarantool.github.io/expirationd/>`_ use ``fiber.name()``
as a key to identify background tasks. If a name is truncated, this fact was
silently missed. The new behavior allows to detect bugs caused by ``fiber.name()``
truncation. Please use ``fiber.name(name, { truncate = true })`` to emulate
Expand Down