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.

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

Add versioning support #89

Closed
appetrosyan opened this issue Jul 25, 2022 · 2 comments
Closed

Add versioning support #89

appetrosyan opened this issue Jul 25, 2022 · 2 comments
Assignees
@6r1d
Labels
M-meta Issues/PRs on the documentation itself (presentation, localization, navigation, etc.)

Comments

@appetrosyan
Copy link
Contributor

We need to support three versions of Iroha simultaneously:

  • Iroha2
  • Iroha2-dev
  • Iroha2-lts

We need to annotate features only present in dev and deprecated since lts.

Proposed solution

Have a custom vitepress environment e.g.

::: Dev-only

for features which are only available in Dev. Another environment for deprecated features (e.g. avaialable in LTS only) and one for difference in behaviour e.g.

::: Diff LTS Dev

In LTS this does X, 

But on `iroha2-dev` it does Y. 
:::
@appetrosyan appetrosyan added documentation M-meta Issues/PRs on the documentation itself (presentation, localization, navigation, etc.) labels Jul 25, 2022
@6r1d
Copy link
Contributor

6r1d commented Jul 25, 2022

I can think of these options right now:

  • Subdomains / directories
  • A custom, or possibly, an existing component to include code / text
  • A custom component to integrate in the docs and show the commands for a given version in the tabs (but that doesn't deal with the documentation text)

@outoftardis outoftardis mentioned this issue Aug 2, 2022
Merged
@outoftardis
Copy link
Contributor

@6r1d which version is going to be the default one? LTS? stable?

@outoftardis outoftardis mentioned this issue Aug 10, 2022
Merged
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 14, 2022
@6r1d
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
fbc98b2 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 14, 2022
@6r1d
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
01715de 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 15, 2022
@6r1d
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
ec93af6 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 15, 2022
@6r1d
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
b174cc6 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 15, 2022
@6r1d
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
ab2cc08 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 15, 2022
@6r1d
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
948bc0d 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 15, 2022
@6r1d
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
d2f7e6e 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 21, 2022
@6r1d
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
104f6e0 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 21, 2022
@6r1d @0x009922
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
b932b09 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
Co-authored-by: 0x009922 <a.marcius26@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 22, 2022
@6r1d @0x009922
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
2d46650 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
Co-authored-by: 0x009922 <a.marcius26@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 22, 2022
@6r1d @0x009922
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
8f605f9 
…sion, update tutorial

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 22, 2022
@6r1d @0x009922
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
f67c2cb 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 22, 2022
@6r1d @0x009922
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
59a91b9 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 22, 2022
@6r1d @0x009922
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
11cde46 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 22, 2022
@6r1d @0x009922 @WRRicht3r
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
5672d0a 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 22, 2022
@6r1d @0x009922 @WRRicht3r
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
5a9faea 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 22, 2022
@6r1d @0x009922 @WRRicht3r
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
8327c62 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 23, 2022
@6r1d @0x009922 @WRRicht3r
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
75a50c4 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 23, 2022
@6r1d @0x009922 @WRRicht3r
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
d7387fd 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 23, 2022
@6r1d @0x009922 @WRRicht3r
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
a7eafb7 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha-2-docs that referenced this issue Sep 23, 2022
@6r1d @0x009922 @WRRicht3r
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
4c6cf88 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
appetrosyan pushed a commit to 6r1d/iroha-2-docs that referenced this issue Sep 23, 2022
@6r1d @0x009922
@WRRicht3r @appetrosyan
[docs] hyperledger-iroha#89: Add scripts, Vue component, parser exten…
de22eee 
…sion, update tutorial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
appetrosyan pushed a commit that referenced this issue Sep 23, 2022
@6r1d @0x009922
@WRRicht3r @appetrosyan
[docs] #89: Add scripts, Vue component, parser extension, update tuto…
31c4829 
…rial

Co-authored-by: 0x009922 <a.marcius26@gmail.com>
Co-authored-by: William Richter <88400283+WRRicht3r@users.noreply.github.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
@6r1d 6r1d mentioned this issue Oct 28, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@6r1d 6r1d

Labels
M-meta Issues/PRs on the documentation itself (presentation, localization, navigation, etc.)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@6r1d @appetrosyan @outoftardis