Skip to content

Add page with list of documentation links for Tarantool modules #3148

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
Tracked by #2051
hackallcode opened this issue Sep 14, 2022 · 3 comments · Fixed by #3159
Closed
Tracked by #2051

Add page with list of documentation links for Tarantool modules #3148

hackallcode opened this issue Sep 14, 2022 · 3 comments · Fixed by #3159
Assignees
Labels
customer Reported by paying customers restructure Related to the transfer of sections, text.

Comments

@hackallcode
Copy link

hackallcode commented Sep 14, 2022

Product: Tarantool
Audience/target: Tarantool customers, Tarantool developers
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_rock/
SME: @ hackallcode

Provide links to at least the most popular rocks. This includes links to Cartridge and metrics, because the users can't always find them right away.

Details

Finding documentation for the Tarantool modules is now quite difficult. When searching by the name of the module in the Tarantool doc, there are dozens of pages in the search results. There is no page on which there will be a list of all Tarantool modules and opposite each one there will be a link to the documentation of the module.

For example, links to documentation for the following modules would be useful to me:

- crud
- checks
- cartridge
- icu-date
- space-explorer
- metrics

Tarantool module registry: https://www.notion.so/tarantool/144028f939df446b8e08b4bad8d285db?v=9a9cd650e2cf42e18d2f6ce76fd96e80

@patiencedaur patiencedaur added the restructure Related to the transfer of sections, text. label Sep 15, 2022
@artur-barsegyan
Copy link
Contributor

Maybe the https://www.tarantool.io/ru/doc/latest/reference/ page can be a root document for that purpose.

@patiencedaur
Copy link
Contributor

patiencedaur commented Sep 15, 2022

Related:

@patiencedaur patiencedaur added needs feedback Something is unclear with the issue customer Reported by paying customers and removed needs feedback Something is unclear with the issue labels Sep 15, 2022
@patiencedaur
Copy link
Contributor

For now, it was decided to provide links to the 6 rock modules above on the Rocks reference page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer Reported by paying customers restructure Related to the transfer of sections, text.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants