diff options
author | Sarah German <sgerman@gitlab.com> | 2022-10-05 01:56:11 +0300 |
---|---|---|
committer | David O'Regan <doregan@gitlab.com> | 2022-10-05 01:56:11 +0300 |
commit | 309860fa7bc365106de9c9e8af83b7edf9a1c92b (patch) | |
tree | 2fbce6fce805d4cfc056e2ca58baa897b815ebb7 /doc | |
parent | b16c762757c462214cae0c5abc9cecd1acc1e805 (diff) |
Refactor the archives banner to use versions.json and GitLab UI
Diffstat (limited to 'doc')
-rw-r--r-- | doc/architecture.md | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/doc/architecture.md b/doc/architecture.md index fde04405..c4ea6a66 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -182,28 +182,32 @@ we reference the array with a symbol (`:versions`). A banner is displayed on archived documentation pages with the text `This is archived documentation for GitLab. Go to the latest.` when either: -- The version of the documentation displayed is not the first version entry in `online` in - `content/_data/versions.yaml`. +- The version of the documentation displayed is not the entry for `current` in + `content/versions.json`. - The documentation was built from the default branch (`main`). -For example, if the `online` entries for `content/_data/versions.yaml` are: - -```yaml -online: - - "14.4" - - "14.3" - - "14.2" +For example, if the entries for `content/versions.json` are: + +```json +[ + { + "next": "15.5", + "current": "15.4", + "last_minor": ["15.3", "15.2"], + "last_major": ["14.10", "13.12"] + } +] ``` In this case, the archived documentation banner isn't displayed: -- For 14.4, the docs built from the `14.4` branch. The branch name is the first entry in `online`. -- For 14.5-pre, the docs built from the default project branch (`main`). +- For 15.4, the docs built from the `15.4` branch. The branch name is the entry in `current`. +- For 15.5, the docs built from the default project branch (`main`). The archived documentation banner is displayed: -- For 14.3. -- For 14.2. +- For 15.3. +- For 14.10. - For any other version. ## Bumping versions of CSS and JavaScript |