Skip to content

[5pt] Toctree in Getting started pages #2591

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
Closed
4 tasks done
patiencedaur opened this issue Jan 20, 2022 · 0 comments · Fixed by #2778
Closed
4 tasks done

[5pt] Toctree in Getting started pages #2591

patiencedaur opened this issue Jan 20, 2022 · 0 comments · Fixed by #2778
Labels
internal Technical debt in the docs

Comments

@patiencedaur
Copy link
Contributor

patiencedaur commented Jan 20, 2022 •
edited
Loading

Some Getting started pages look orphaned

A new Getting Started guide arrived in #2502 (issue #2220). The issue below is a consequence of that.

Some pages in the getting_started source folder are cross-linked, but there is no toctree to connect them. As a result, there are no breadcrumbs, and the pages look orphaned.

Things to fix

  • Getting started with connectors can be accessed from Connecting to cluster but isn't in the general toctree.
  • Looks like Connecting from your favorite language is also detached, although it has its own toctree linking to lowel-level pages.
  • Creating your first Tarantool database: check whether this page is still needed. If the information on the new Getting started pages is duplicate, delete this page. Otherwise, provide cross-links. If this page contains a little piece of info that cannot be found in the Getting Started pages accessible to the user, please add this info to the new Getting Started pages and delete this page.
  • Check if anything else in the getting_started folder got detached during the renovation.
@patiencedaur patiencedaur added the internal Technical debt in the docs label Jan 20, 2022
@patiencedaur patiencedaur changed the title [3pt] Toctree in Getting started pages [5pt] Toctree in Getting started pages Jan 20, 2022
@patiencedaur patiencedaur mentioned this issue Jan 26, 2022
Merged
@art-dr art-dr mentioned this issue Jan 27, 2022
Merged
patiencedaur added a commit that referenced this issue Mar 25, 2022
@patiencedaur
Put the Getting Started pages together in a toctree
2b3be6a 
Resolves #2591
@patiencedaur patiencedaur mentioned this issue Mar 25, 2022
Merged
patiencedaur added a commit that referenced this issue Mar 28, 2022
@patiencedaur
Put the Getting Started pages together in a toctree (#2778)
96bd5f6 
Resolves #2591
* Put the Getting Started pages together in a toctree
* Add link to the C++ connector in the beginners' tutorial
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
internal Technical debt in the docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Put the Getting Started pages together in a toctree tarantool/doc
1 participant
@patiencedaur