|
| 1 | +# Documentation deploy process for Tarantool Java SDK |
| 2 | + |
| 3 | +The Tarantool Java SDK documentation is located on the GitHub pages. The link can be found on the |
| 4 | +main page of the repository. |
| 5 | + |
| 6 | +The documentation is deploying under two different scenarios: |
| 7 | + |
| 8 | +1. `dev` - unreleased documentation. These documents contain all the information about capabilities |
| 9 | + and features of the Tarantool Java SDK that have not yet been released (tag). This includes |
| 10 | + information about any innovations and opportunities currently under development. **Information is |
| 11 | + subject to change and may not be accurate until next release.** |
| 12 | +2. `X.Y.*` is the release version of the documentation. Here is the released information about |
| 13 | + capabilities and features of the Tarantool Java SDK that are specific to a particular release. |
| 14 | + Not here contains information about innovations that go beyond the scope of this release. |
| 15 | + Information in documentation **can be supplemented, clarified and revised only about those |
| 16 | + recorded in this release capabilities**. Also, information **can be corrected if errors are |
| 17 | + found in the text documentation**. |
| 18 | + |
| 19 | +## Documentation deploy process |
| 20 | + |
| 21 | +### Dev documentation |
| 22 | + |
| 23 | +`dev-documentation` is deployed every time changes from branches are pushed to master |
| 24 | +`master` branch. |
| 25 | + |
| 26 | +### Release documentation |
| 27 | + |
| 28 | +Release documentation is deployed manually. In order to deploy documentation for a specific |
| 29 | +*major-minor** version of the Tarantool Java SDK, follow these steps: |
| 30 | + |
| 31 | +* Go to the `Actions` section and select `release-documentation` workflow |
| 32 | +* Click **Run workflow** and select the required tag (`Run workflow` → `Tags`) |
| 33 | +* **(Only for tags _1.5.x_ and _1.6.x_)** Select tag `1.6.0` and enter the required tag, e.x. |
| 34 | + `1.5.101` (this is necessary because these tags work on the old compatible workflow) |
0 commit comments