Skip to content
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

[60pt] Highlight box.cfg parameters origin version #1415

Closed
artur-barsegyan opened this issue Jul 20, 2020 · 2 comments
Closed

[60pt] Highlight box.cfg parameters origin version #1415

artur-barsegyan opened this issue Jul 20, 2020 · 2 comments
Assignees
Labels
add details [nature] More details needed, some info missing. Documentation is incomplete. reference [location] Tarantool manual, Reference part

Comments

@artur-barsegyan
Copy link
Contributor

artur-barsegyan commented Jul 20, 2020

Motivation

Tarantool evolves and new features have come. When a user reads about the needed feature, he looks at the version where that feature is available. Now, the user first needs to check all supported versions at the site and find the last mention about that feature. In the case of 1.10.0 — 1.10.latest minor releases, the user can't have the ability to find the feature origin.

Brief motivation list:

  1. New features are not marked about origin version
  2. Sometimes users don't see the version marker at the documentation page/URL link.

Vadim, [12:23:57 PM]:
Спасибо. А есть пример использования где-то?
Eugene, [12:28:05 PM]:
https://www.tarantool.io/en/doc/2.3/reference/reference_lua/box_sql/
Vadim, [12:39:08 PM]:
А с какой версии это? У меня 2.2. сейчас и box.prepare там нет

  1. Tarantool's 1.10 users don't have any mentions about changes in API or behavior at all. Only through release notes.

What need to do

Mark all box and Cartridge's parameters with mentioning about origin version

For example:

box.prepare(sql-statement)

New in version 2.3

@Totktonada
Copy link
Member

I vote for exact four-digit versions to overcome any possible ambiguity.

@lenkis lenkis added 1.10 add details [nature] More details needed, some info missing. Documentation is incomplete. reference [location] Tarantool manual, Reference part labels Jul 24, 2020
@Totktonada
Copy link
Member

The following features should help the Documentation Team to obtain tarantool versions, which corresponds to a particular feature or behaviour change:

@Onvember Onvember changed the title Highlight parameters origin version [24pt] Highlight parameters origin version Aug 25, 2020
@artur-barsegyan artur-barsegyan changed the title [24pt] Highlight parameters origin version [24pt] Highlight box.cfg parameters origin version Aug 27, 2020
@Onvember Onvember changed the title [24pt] Highlight box.cfg parameters origin version [60pt] Highlight box.cfg parameters origin version Aug 31, 2020
Onvember added a commit that referenced this issue Aug 31, 2020
@Onvember Onvember closed this as completed Sep 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add details [nature] More details needed, some info missing. Documentation is incomplete. reference [location] Tarantool manual, Reference part
Projects
None yet
Development

No branches or pull requests

4 participants