Skip to content

Add more style-related instructions on writing docs #2539

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 13 commits into from
Jan 18, 2022

Conversation

patiencedaur
Copy link
Contributor

  • Style recommendations
  • Advice on table formatting and code snippets
  • Altered structure

This is to help our external contributors.

@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 11, 2022 12:46 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 11, 2022 12:46 Inactive
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 11, 2022 12:47 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 11, 2022 12:47 Inactive
@patiencedaur patiencedaur force-pushed the expand-docs-style-guide branch from 57cd303 to 23e221b Compare January 11, 2022 12:55
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 11, 2022 12:57 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 11, 2022 12:57 Inactive
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 11, 2022 12:58 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 11, 2022 12:59 Inactive
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 11, 2022 13:02 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 11, 2022 13:03 Inactive
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 11, 2022 13:12 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 11, 2022 13:13 Inactive

Good example:

.. image:: images/do.png
Copy link
Contributor

Choose a reason for hiding this comment

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

заметила, что строки в таблице не отбиты пустой строкой — вроде в нашем гайдлайне в примере есть пустая строка + помню, коля говорил, что лучше отбивать: https://www.tarantool.io/en/doc/latest/contributing/docs/markup/tables/

Copy link
Contributor Author

@patiencedaur patiencedaur Jan 12, 2022

Choose a reason for hiding this comment

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

не знала, что это работает. спасибо!
картинки, наверное, всё же оставлю. они достаточно иллюстративны
чтобы переделать скриншот, мне нужно было бы переделывать документ на 1000+ строк, и тогда он будет на 1500+ строк )))

@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 12, 2022 05:39 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 12, 2022 05:39 Inactive
@patiencedaur patiencedaur force-pushed the expand-docs-style-guide branch from c8be792 to 8227ad7 Compare January 12, 2022 07:02
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 12, 2022 07:04 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 12, 2022 07:04 Inactive
@patiencedaur patiencedaur force-pushed the expand-docs-style-guide branch from 8227ad7 to 779b6f7 Compare January 12, 2022 07:47
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 12, 2022 07:49 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 12, 2022 07:49 Inactive
@patiencedaur patiencedaur force-pushed the expand-docs-style-guide branch from 779b6f7 to aa13cb1 Compare January 12, 2022 09:29
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 12, 2022 09:30 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 12, 2022 09:31 Inactive
@art-dr art-dr self-requested a review January 12, 2022 10:37
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 12, 2022 13:53 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 12, 2022 13:53 Inactive
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 13, 2022 09:48 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 13, 2022 09:48 Inactive
Comment on lines +222 to +223
all similar list/table items end with a period or they all don't.
Copy link
Member

Choose a reason for hiding this comment

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

'Your table punctuation' assumes a column here? Can we say that a punctuation is a column is the same as for a list?

@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 14, 2022 12:53 Inactive
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 14, 2022 12:53 Inactive
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 17, 2022 08:20 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 17, 2022 08:20 Inactive
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 17, 2022 13:01 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 17, 2022 13:01 Inactive
@github-actions github-actions bot temporarily deployed to translation-expand-docs-style-guide January 18, 2022 08:13 Inactive
@github-actions github-actions bot temporarily deployed to branch-expand-docs-style-guide January 18, 2022 08:13 Inactive
@patiencedaur patiencedaur merged commit 755097e into latest Jan 18, 2022
@patiencedaur patiencedaur deleted the expand-docs-style-guide branch January 18, 2022 08: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