mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-22 16:36:27 +01:00

Roman Khavronenko c6a8ebb11f

docs: update docs ordering and formatting (#1192 )

The major change is adding `sort` directive to docs. For those docs which are copied
from internal packages `sort` is added via makefile command. For the rest it is added
manually since they're updated manually as well.

The rest of changes is connected with markdown formatting. For example, changing headers
in some files (`##` => `#`) makes navigation on .github.io to look better. This especially
useful for `changelog` docs.

Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io.

No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.

2021-04-07 13:39:16 +03:00

3.5 KiB

Raw Blame History

sort
14

Release process guidance

Release version and Docker images

Document all the changes for new release in CHANGELOG.md.
Create release tag with git tag v1.xx.y in master branch and git tag v1.xx.y-cluster in cluster branch.
Run make release for creating *.tar.gz release archive with the corresponding _checksums.txt inside bin directory.
Run make publish for creating and publishing Docker images.
Repeat steps 3-4 for cluster branch.
Push release tag to https://github.com/VictoriaMetrics/VictoriaMetrics : git push origin v1.xx.y.
Go to https://github.com/VictoriaMetrics/VictoriaMetrics/releases , create new release from the pushed tag on step 5 and upload *.tar.gz archive with the corresponding _checksums.txt from step 2.

Building snap package.

pre-requirements:

snapcraft binary, can be installed with commands: for MacOS brew install snapcraft and install mutipass, for Ubuntu - sudo snap install snapcraft --classic
login with snapcraft login
already created release at github (it operates git describe version, so git tag must be annotated).

checkout to the latest git tag for single-node version.
execute make release-snap - it must build and upload snap package.
promote release to current, if needed manually at release page snapcraft-releases

Public Announcement

Publish message in slack (victoriametrics.slack.com, general channel)
Post twit with release notes URL
Post in subreddit https://www.reddit.com/r/VictoriaMetrics/
Post in linkedin

Helm Charts

The helm chart repository https://github.com/VictoriaMetrics/helm-charts/

Bump the version of images.

In that case, don't need to bump the helm chart version

Need to update values.yaml, bump version for vmselect, vminsert and vmstorage
Specify the correct version in Chart.yaml
Update version README.md, specify the new version in the documentation
Push changes to master. master is a source of truth
Rebase master into gh-pages branch
Run make package which creates or updates zip file with the packed chart
Run make merge. It creates or updates metadata for charts in index.yaml
Push the changes to gh-pages branch

Updating the chart.

Update chart version in Chart.yaml
Update README.md file, reflect changes in the documentation.
Repeat the procedure from step 4 previous section.

Wiki pages

All changes from docs folder and .md extension automatically push to Wiki

Note: no vice versa, direct changes on Wiki will be overitten after any changes in docs/*.md

Github pages

All changes in README.md, docs folder and .md extension automatically push to Wiki

3.5 KiB Raw Blame History