Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release notes on elemental.docs.rancher.com #165

Closed
kkaempf opened this issue Jul 12, 2023 · 2 comments
Closed

Release notes on elemental.docs.rancher.com #165

kkaempf opened this issue Jul 12, 2023 · 2 comments
Assignees

Comments

@kkaempf
Copy link
Contributor

kkaempf commented Jul 12, 2023

(This is a possible solution/workaround for rancher/elemental#875)

As we release new versions (of elemental, elemental-operator, or the node image), we need a way to inform users
about the changes within.

Esp. the backup/restore fix needs manual intervention to take full effect.

We should start by enhancing our documentation with "release notes" for the various components.

Long-term, these release notes should be visible in the UI though.

@kkaempf kkaempf converted this from a draft issue Jul 12, 2023
@kkaempf
Copy link
Contributor Author

kkaempf commented Jul 12, 2023

Assigning to @nunix asking for respective docs infrastructure/setup so that engineering has a place to put release notes.

We need (at least) three components

  • elemental (incl. elemental-toolkit, -register, and -cli)
  • elemental-operator
  • node image

Each component is versioned. Release notes are per-component, per-version.

nunix added a commit to nunix/elemental-docs-repo that referenced this issue Jul 28, 2023
The release notes page has been added to `v1.2` and `next` versions.

The page will be part of the docs versioning and the versions listed in the release notes are fixed to the specific version.

This PR addresses rancher#124 rancher#165 and rancher#176

Signed-off-by: Nuno do Carmo [email protected]
nunix added a commit that referenced this issue Jul 30, 2023
* Added release notes page

The release notes page has been added to `v1.2` and `next` versions.

The page will be part of the docs versioning and the versions listed in the release notes are fixed to the specific version.

This PR addresses #124 #165 and #176

Signed-off-by: Nuno do Carmo [email protected]

* Applied @fgiudici feedback

Signed-off-by: Nuno do Carmo [email protected]

* Updated v1.2 with @fgiudici feedback

Signed-off-by: Nuno do Carmo [email protected]

---------

Signed-off-by: Nuno do Carmo [email protected]
@nunix
Copy link
Contributor

nunix commented Jul 31, 2023

Release notes page has been implemented. This issue can be closed.

@nunix nunix closed this as completed Jul 31, 2023
@github-project-automation github-project-automation bot moved this from 💡 Backlog to ✅ Done in Elemental Jul 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

No branches or pull requests

2 participants