Skip to content

Conversation

@p7nov
Copy link
Contributor

@p7nov p7nov commented Oct 2, 2023

Improve formatting of tt command-line reference pages in accordance with Google and RedHat style guides:

  • Rename Flags and Arguments to Options (including arguments.rst > global_options.rst).
  • Make code blocks with tt calls console instead of bash.
  • Use ::option: lists instead of tables for tt command options.
  • Fix synopsis across the reference

Deployment: https://docs.d.tarantool.io/en/doc/improve-tt-commands-syntax/reference/tooling/tt_cli/commands/

@p7nov p7nov changed the title Fix options formatting in tt reference Polish tt reference: options formatting, terminology, code blocks Oct 2, 2023
@p7nov p7nov requested a review from andreyaksenov October 2, 2023 10:48
@p7nov p7nov requested a review from andreyaksenov October 3, 2023 07:40
Copy link
Contributor

@andreyaksenov andreyaksenov left a comment

Choose a reason for hiding this comment

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

great work!

@p7nov p7nov merged commit d64ca9b into latest Oct 3, 2023
@p7nov p7nov deleted the improve-tt-commands-syntax branch October 3, 2023 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants