Skip to content

Commit efbba19

Browse files
author
Peter Nagy
committed
Remove changelog as moved to main site
1 parent 0ea9744 commit efbba19

10 files changed

+10
-2225
lines changed

CHANGELOG.md

Lines changed: 0 additions & 660 deletions
This file was deleted.

DOCS-INTERNAL.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,5 @@
11
# Docs internal processes
22

3-
This document describes some processes used internally for:
4-
5-
1. Updating **product** changelogs
6-
2. Performing a docs release
7-
8-
Each of these is described in the following sections.
9-
10-
## Product changelogs
11-
12-
The latest changelog entry is located at the top of `CHANGELOG.md`. This changelog contains all entries for the current year.
13-
14-
> **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).
15-
16-
At the bottom of this file are links to archived changelogs. There is one file for each previous year.
17-
18-
The archived changelogs are stored in the `changelogs` folder.
19-
20-
### Updating the changelog
21-
22-
> **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.
23-
24-
To update the changelog:
25-
26-
1. Create a PR in the [docs repo](https://github.com/quixio/quix-docs) on the `dev` branch.
27-
28-
> **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.
29-
30-
2. Add your changelog entry to the top of `CHANGELOG.md`.
31-
32-
3. When ready, submit your PR for review. The changes will be reviewed and merged to the `dev` branch.
33-
34-
> **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.
35-
36-
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.
37-
38-
### Archiving a year
39-
40-
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.
41-
42-
### Changelog location
43-
44-
The latest product changelog file is always located at:
45-
46-
https://github.com/quixio/quix-docs/blob/dev/CHANGELOG.md
47-
48-
From this file you can locate the changelog from previous years, by following the links at the bottom of the file.
49-
503
## Docs release
514

525
To do a docs release the process is:

changelogs/2022-archive.md

Lines changed: 0 additions & 317 deletions
This file was deleted.

0 commit comments

Comments
 (0)