Skip to content

[doc] TDB (RESP): Update CI for doc building and publishing #4710

Open
@xuniq

Description

@xuniq

Product: TDB (RESP)
Root document:

SME: @ 0x501D @ lastoCHka42
Doc deploy instruction: https://confluence.vk.team/pages/viewpage.action?pageId=1380111583#id-%D0%94%D0%B5%D0%BF%D0%BB%D0%BE%D0%B9%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D0%B8-%D0%94%D0%B5%D0%BF%D0%BB%D0%BE%D0%B9docx

Details

Currently, the TDB (RESP docs are deployed to test and prod environment from the master branch only (latestversion in the version chooser).
We need to update CI for TDB (RESP) docs. The new pipelines should deploy test and prod documentation for two versions:

  • 1.3.0 - will be published from the 1.3.0 tag branch
  • latest (2.0+) - will be published from the master branch

What needs to be done

  1. Discuss the version naming with PM and @ 0x501D
  2. Update naming for the latest version in the version chooser. The new naming: latest (2.0+) ?
  3. Enable doc build and deploy (test and prod) for the 1.3.0 version tag. The docs from this branch are to be published as the 1.3.0 version in the version chooser.

Definition of done

  • Enabled GitLab workflow for building and publishing TDB (RESP) 1.3.0 docs on test and prod env from the v1.3.0 tag.
  • This workflow publishes the docs as the 1.3.0 version in the version chooser on Tarantool website.
  • Enabled GitLab workflow for building and publishing TDB (RESP) 2.1.0 docs on test and prod env from the master branch.
  • The docs from master are published on prod as the latest (2.0+) version in the version chooser on Tarantool website.
  • If there is no doc version in the URL or the stated version doesn't exist, the site redirects to the latest docs.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions