Skip to content

Commit

Permalink
Create Docs 1.28 Version Release (#968)
Browse files Browse the repository at this point in the history
* Create Docs 1.28 Version Release

* add new docs and sidebar

* update current variables

* update readme with variables clarification

---------

Co-authored-by: Cody Landstrom <[email protected]>
  • Loading branch information
codyjlandstrom and Cody Landstrom authored Jan 13, 2025
1 parent cdda3ca commit 78633ad
Show file tree
Hide file tree
Showing 169 changed files with 12,051 additions and 5,807 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,15 @@ You can launch a remote Development Environment with [Okteto](https://okteto.com
*A new version of the docs is created once the documentation for a certain version is "finished". This is typically done in preparation of a new release.*
### Update Variables
Before creating a new version, update the variables so that they are included in the released version:
Review the content of `src/content/variables.json` and update the values of `cliVersion` and `chartVersion`. \
If the release comes with a new or a removed Kubernetes version, update `kubernetesMinVersion` and `kubernetesMaxVersion` accordingly. \
Finally, update the value of `syncthingVersion` with the version specified [here](https://github.com/okteto/okteto/blob/master/Dockerfile#L3).
### Create a new version
To create a new version, run the following commands:
Expand All @@ -49,15 +58,6 @@ yarn run docusaurus docs:version 1.XX
This will create a new version with the docs on your current branch.
### Update Variables
Review the content of `src/content/variables.json` and update the values of `cliVersion` and `chartVersion`.
If the release comes with a new or a removed Kubernetes version, update `kubernetesMinVersion` and `kubernetesMaxVersion` accordingly.
Finally, update the value of `syncthingVersion` with the version specified [here](https://github.com/okteto/okteto/blob/master/Dockerfile#L3).
### Change the default version
*The default version of the docs is created and published once a new version of Okteto is available. This is typically done as part of the release process of Okteto Self-Hosted.*
Expand Down
20 changes: 10 additions & 10 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -239,21 +239,26 @@ module.exports = {
editUrl: 'https://github.com/okteto/docs/edit/main',
breadcrumbs: false,
sidebarPath: require.resolve('./sidebars.js'),
lastVersion: '1.27',
lastVersion: '1.28',
versions: {
current: {
// aka unreleased version in development
// Remember to also update "unreleased" redirect if changing the value!
label: '1.28',
path: '1.28',
label: '1.29',
path: '1.29',
},
1.27: {
1.28: {
// aka latest/official version
// Remember to also update docs root redirect if changing the value!
label: '1.27',
label: '1.28',
path: '/',
banner: 'none',
},
1.27: {
label: '1.27',
path: '1.27',
banner: 'unmaintained',
},
1.26: {
label: '1.26',
path: '1.26',
Expand All @@ -274,11 +279,6 @@ module.exports = {
path: '1.23',
banner: 'unmaintained',
},
1.22: {
label: '1.22',
path: '1.22',
banner: 'unmaintained',
},
},
include: ['**/*.md', '**/*.mdx'],
},
Expand Down
10 changes: 8 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -631,14 +631,20 @@

# Redirect official version to docs root
[[redirects]]
from = "/docs/1.27/*"
from = "/docs/1.28/*"
to = "/docs/:splat"
status = 301

# Redirect unreleased to "current" version
[[redirects]]
from = "/docs/unreleased/*"
to = "/docs/1.28/:splat"
to = "/docs/1.29/:splat"
status = 302

# Redirect deprecated versions
[[redirects]]
from = "/docs/1.16/*"
to = "/docs/:splat"
status = 302

# Redirect deprecated versions
Expand Down
45 changes: 45 additions & 0 deletions src/content/archived-release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,51 @@ id: archived-release-notes

Here you can find the release notes for archived versions of Okteto.

## 1.16.2

17 January 2024

This version is compatible with Kubernetes versions 1.25 to 1.28.

### Bugfixes

- Fixed a scenario where node container runtimes could restart if the Okteto daemon pod were to be recreated, potentially impacting active 'okteto up' sessions. <!-- 7625 -->

## 1.16.1

10 January 2024

This version is compatible with Kubernetes versions 1.25 to 1.28.

### Bugfixes

- The Okteto CLI used for Pipeline installation has been upgraded to version [2.23.3](https://github.com/okteto/okteto/releases/tag/2.23.3). It includes a fix for scenarios where image builds were failing because an image was not being found in the global registry.
- The Okteto Insights endpoint was not exposing build metrics when the Helm release name included the word "okteto"

## 1.16.0

20 December 2023

This version is compatible with Kubernetes versions 1.25 to 1.28.

### Features

- Add `okteto_usage_build_duration_seconds` build metrics to okteto insights. More info [here](admin/okteto-insights.mdx) <!-- 7445 -->
- A diagnostics tool is now provided to help troubleshoot installations. More info [here](self-hosted/manage/diagnostics.mdx)
- The Okteto CLI used for Pipeline installation has been upgraded to version [2.23.1](https://github.com/okteto/okteto/releases/tag/2.23.1)
- Move garbage collection of `okteto up` based on last synced file behind a feature flag. More info [here](self-hosted/helm-configuration.mdx#gc) <!-- 7424 -->
- Okteto now runs in ARM architecture. This is currently in beta.

### Improvements

- Okteto garbage collector cronjob now resolves buildkit and ingress hosts to their internal IPs <!-- 7432 -->
- Registry Credentials cronjob only update dockerconfig secret if the credentials change. <!-- 7474 -->
- Okteto Daemon now update kubelet docker config.json file in nodes reactively when the static docker config secret changes. Bumps okteto/daemon to 0.5.1
- Fix network policies configuration to limit buildkit access to the nginx controller <!-- 7505 -->
- Add Okteto Insights Token to the Admin UI <!-- 7473 -->
- Updated documentation structure to make content easier to navigate and find. Release notes can now be found at [https://www.okteto.com/docs/release-notes](release-notes.mdx), and chart values reference can be found at [https://www.okteto.com/docs/reference/helm-chart-values/](self-hosted/helm-configuration.mdx).
All documentation changes are listed [here](https://github.com/okteto/docs/pulls?q=is%3Apr+label%3Adoc-restructure+).

## 1.15.1

1 December 2023
Expand Down
46 changes: 1 addition & 45 deletions src/content/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -655,48 +655,4 @@ This version is compatible with Kubernetes versions 1.25 to 1.28.

- Surface buildkit errors through our ingress controller. Will result in better build error messages <!-- 7526 -->
- The Okteto Insights endpoint was not exposing build metrics when the Helm release name included the word "okteto" <!-- 7600 -->
- Fixed a scenario where the runtime of node containers could restart if the Okteto daemon pod were to be recreated, potentially impacting active 'okteto up' sessions <!-- 7625 -->

## 1.16.2

17 January 2024

This version is compatible with Kubernetes versions 1.25 to 1.28.

### Bugfixes

- Fixed a scenario where node container runtimes could restart if the Okteto daemon pod were to be recreated, potentially impacting active 'okteto up' sessions. <!-- 7625 -->

## 1.16.1

10 January 2024

This version is compatible with Kubernetes versions 1.25 to 1.28.

### Bugfixes

- The Okteto CLI used for Pipeline installation has been upgraded to version [2.23.3](https://github.com/okteto/okteto/releases/tag/2.23.3). It includes a fix for scenarios where image builds were failing because an image was not being found in the global registry.
- The Okteto Insights endpoint was not exposing build metrics when the Helm release name included the word "okteto"

## 1.16.0

20 December 2023

This version is compatible with Kubernetes versions 1.25 to 1.28.

### Features

- Add `okteto_usage_build_duration_seconds` build metrics to okteto insights. More info [here](admin/okteto-insights.mdx) <!-- 7445 -->
- A diagnostics tool is now provided to help troubleshoot installations. More info [here](self-hosted/manage/diagnostics.mdx)
- The Okteto CLI used for Pipeline installation has been upgraded to version [2.23.1](https://github.com/okteto/okteto/releases/tag/2.23.1)
- Move garbage collection of `okteto up` based on last synced file behind a feature flag. More info [here](self-hosted/helm-configuration.mdx#gc) <!-- 7424 -->
- Okteto now runs in ARM architecture. This is currently in beta.

### Improvements

- Okteto garbage collector cronjob now resolves buildkit and ingress hosts to their internal IPs <!-- 7432 -->
- Registry Credentials cronjob only update dockerconfig secret if the credentials change. <!-- 7474 -->
- Okteto Daemon now update kubelet docker config.json file in nodes reactively when the static docker config secret changes. Bumps okteto/daemon to 0.5.1
- Fix network policies configuration to limit buildkit access to the nginx controller <!-- 7505 -->
- Add Okteto Insights Token to the Admin UI <!-- 7473 -->
- Updated documentation structure to make content easier to navigate and find. Release notes can now be found at [https://www.okteto.com/docs/release-notes](release-notes.mdx), and chart values reference can be found at [https://www.okteto.com/docs/reference/helm-chart-values/](self-hosted/helm-configuration.mdx). All documentation changes are listed [here](https://github.com/okteto/docs/pulls?q=is%3Apr+label%3Adoc-restructure+).
- Fixed a scenario where the runtime of node containers could restart if the Okteto daemon pod were to be recreated, potentially impacting active 'okteto up' sessions <!-- 7625 -->
6 changes: 3 additions & 3 deletions src/content/variables.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"kubernetesMinVersion": "1.27",
"kubernetesMaxVersion": "1.30",
"cliVersion": "3.2.3",
"chartVersion": "1.27.2",
"syncthingVersion": "1.28.0"
"cliVersion": "3.3.0",
"chartVersion": "1.28.1",
"syncthingVersion": "1.28.1"
}
4 changes: 2 additions & 2 deletions src/pages/archives.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@ Here you can find the documentation for the current released version of Okteto.

| Version | Documentation | Release Notes |
| :------ | :----------------: | -------------------------------: |
| 1.27 | [Documentation](/) | [Release Notes](/release-notes/) |
| 1.28 | [Documentation](/) | [Release Notes](/release-notes/) |

## Previously released versions

Here you can find the documentation for previously released versions of Okteto.

| Version | Documentation | Release Notes |
| :------ | :--------------------: | ---------------------------------------------------: |
| 1.27 | [Documentation](/1.27) | [Release Notes](/1.27/release-notes/) |
| 1.26 | [Documentation](/1.26) | [Release Notes](/1.26/release-notes/) |
| 1.25 | [Documentation](/1.25) | [Release Notes](/1.25/release-notes/) |
| 1.24 | [Documentation](/1.24) | [Release Notes](/1.24/release-notes/) |
Expand All @@ -31,6 +32,5 @@ Here you can find the documentation for previously released versions of Okteto.
| 1.19 | [Documentation](/1.19) | [Release Notes](/1.19/release-notes/) |
| 1.18 | [Documentation](/1.18) | [Release Notes](/1.18/release-notes/) |
| 1.17 | [Documentation](/1.17) | [Release Notes](/1.17/release-notes/) |
| 1.16 | [Documentation](/1.16) | [Release Notes](/1.16/release-notes/) |

Release notes for previous versions can be found here: [Archived Release Notes](/archived-release-notes/)
93 changes: 0 additions & 93 deletions versioned_docs/version-1.16/admin/catalog.mdx

This file was deleted.

Loading

0 comments on commit 78633ad

Please sign in to comment.