Skip to content

[3pt] [Contribution Guide]: TOC revising #1706

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

Open
veod32 opened this issue Dec 17, 2020 · 5 comments
Open

[3pt] [Contribution Guide]: TOC revising #1706

veod32 opened this issue Dec 17, 2020 · 5 comments

Comments

@veod32
Copy link
Collaborator

veod32 commented Dec 17, 2020

Related to #1655

Revise high-level CG TOC based on discussion with @Totktonada -- mainly on Development part.

  1. Introduction (landing page -- revised https://www.tarantool.io/en/doc/latest/contributing/contributing/)
  2. Development
    • Development workflow overview
    • Seting up development environment
    • Making build
    • Running tests
    • Coding
    • Writting tests
    • Before sending patch
    • Self-review checklist
    • Sending patch
    • C style guide
    • Lua style guide
  3. Feedbacks and suggestions
    • Submitting feedbacks and suggestions
    • Bug reporting -- может относиться сюда, а не к разделу Development; что-то уже есть в док-ции /admin
  4. Documentation
    • Contributing to Tarantool documentation
    • Documentation style guide
@veod32 veod32 self-assigned this Dec 17, 2020
@veod32 veod32 closed this as completed Dec 17, 2020
@artur-barsegyan
Copy link
Contributor

Need review with @Totktonada and @Mons

@NickVolynkin
Copy link
Contributor

Planning:

  • finalize TOC structure
  • make new issues for each child document

@NickVolynkin
Copy link
Contributor

Btw, did we look at the amount of page visits? We could move more popular pages up a level.

@artur-barsegyan
Copy link
Contributor

Btw, did we look at the amount of page visits? We could move more popular pages up a level.

I have that report. You can ping me on Telegram.

@NickVolynkin
Copy link
Contributor

Related issue: #1797

@NickVolynkin NickVolynkin self-assigned this Feb 25, 2021
@veod32 veod32 changed the title [6pt] [Contribution Guide]: TOC revising [3pt] [Contribution Guide]: TOC revising Feb 26, 2021
@TarantoolBot TarantoolBot removed the 3sp label Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants