Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
660 changes: 0 additions & 660 deletions CHANGELOG.md

This file was deleted.

47 changes: 0 additions & 47 deletions DOCS-INTERNAL.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,5 @@
# Docs internal processes

This document describes some processes used internally for:

1. Updating **product** changelogs
2. Performing a docs release

Each of these is described in the following sections.

## Product changelogs

The latest changelog entry is located at the top of `CHANGELOG.md`. This changelog contains all entries for the current year.

> **Note:** `CHANGELOG.md` is the product changelog, not the docs changelog. The docs changelog can be found [here](https://github.com/quixio/quix-docs/wiki/Docs-Releases).

At the bottom of this file are links to archived changelogs. There is one file for each previous year.

The archived changelogs are stored in the `changelogs` folder.

### Updating the changelog

> **Note:** If you do not wish to carry out the procedure below, simply give the changelog entry content to a member of the docs team, and they will update the changelog for you.

To update the changelog:

1. Create a PR in the [docs repo](https://github.com/quixio/quix-docs) on the `dev` branch.

> **Important:** The PR **MUST** be raised on the `dev` branch as we check for broken builds by building a preview site based on this branch. We avoid raising PRs on `main` for this reason.

2. Add your changelog entry to the top of `CHANGELOG.md`.

3. When ready, submit your PR for review. The changes will be reviewed and merged to the `dev` branch.

> **Important:** Merges are only periodically made from `dev` to `main` (typically for a docs release). For this reason the *latest version* of the changelog should be considered to be the one stored on the `dev` branch.

Unlike for the main docs, a docs release is not required for the changelog, because the changelog is a Markdown file, and not a file rendered by the docs system.

### Archiving a year

At the end of the year, the contents of `CHANGELOG.md` can be cut and pasted to an archive file. The file has the name `YYYY-archive.md` where `YYYY` is the year of the changelog entries. This will give you a clean `CHANGELOG.md` file to which you can add the changelog entries for the current year.

### Changelog location

The latest product changelog file is always located at:

https://github.com/quixio/quix-docs/blob/dev/CHANGELOG.md

From this file you can locate the changelog from previous years, by following the links at the bottom of the file.

## Docs release

To do a docs release the process is:
Expand Down
317 changes: 0 additions & 317 deletions changelogs/2022-archive.md

This file was deleted.

Loading