tarantool / tarantool/doc

Implement CI/CD for pilot doc project on VK Cloud docs engine

Open
#4,314 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

We have a pilot docs project on the VK Cloud docs engine: https://github.com/tarantool/doc-md.
As a next step, we need a CI/CD for this project like we have for existing Tarantool docs:

  1. Automatic staging of PRs to master. The staging must update on new commits pushed to the source branch.
  2. Manual staging deployment of any branch.
  3. Production deployment:
  • on merging to master
  • on schedule (once a day?)
  • manual

Note:

  • it's a general description. We'll decide on the new docs portal URL and some other details later together with DevX team.
  • ожидается помощь/консультации от команды разработки и девопс движка

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked tarantool/doc-md project and the CI/CD used by existing Tarantool documentation. Clarify the VK Cloud portal URL and deployment details with the DevX team before implementing the workflows. Done means PR staging updates on new commits, branch staging is manual, and production supports merge, scheduled, and manual deployments.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, cloud, devops, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.