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

Document CAPI releases/upgrades #2825

Closed
3 tasks
teemow opened this issue Sep 13, 2023 · 9 comments
Closed
3 tasks

Document CAPI releases/upgrades #2825

teemow opened this issue Sep 13, 2023 · 9 comments
Assignees
Labels
area/kaas Mission: Cloud Native Platform - Self-driving Kubernetes as a Service team/turtles Team Turtles

Comments

@teemow
Copy link
Member

teemow commented Sep 13, 2023

Motivation

As we heavily investigated a clear, formalised release flow for CAPI, we now have to document our outcome so that everyone can be onboarded to this new release process.

Todo

  • Create internal documentation for our intranet with the details of the new release flow
  • Derive a public documentation for our customers from the internal documentation
  • Look through the intranet and public docs for existing release documentation and if they are still up to date with the new information

Outcome

  • We have a clear documentation of the release flow for internal use in the intranet
  • We have a clear documentation for our customers in the public doc
  • All existing documentations around releases are either up to date or we have follow up tickets to update them.
@architectbot architectbot added the team/planeteers Team Planeteers (Customer Success & Product Management) label Sep 13, 2023
@alex-dabija alex-dabija assigned Rotfuks and unassigned alex-dabija Sep 27, 2023
@alex-dabija alex-dabija added team/turtles Team Turtles area/kaas Mission: Cloud Native Platform - Self-driving Kubernetes as a Service and removed team/planeteers Team Planeteers (Customer Success & Product Management) labels Sep 27, 2023
@teemow
Copy link
Member Author

teemow commented Sep 27, 2023

@Rotfuks can you fill in the existing issues from turtles here please.

@JosephSalisbury
Copy link
Contributor

@Rotfuks what's the state here? "investigation" feels less ready to get going than "backlog"

@JosephSalisbury
Copy link
Contributor

from migration sync: we think a lot has happened, it'd be helpful to have a lil' update here

@Rotfuks
Copy link
Contributor

Rotfuks commented Oct 16, 2023

As we're currently still in the investigation phase of the future Release process we have no customer ready documentation yet. But internal documentation of the progress is here: https://miro.com/app/board/uXjVM0oMunQ=/?share_link_id=61564219597

This story will be done as a closure of the investigation so to say :)

@Rotfuks Rotfuks changed the title Document CAPI releases/upgrades for customers Document CAPI releases/upgrades Oct 23, 2023
@Rotfuks
Copy link
Contributor

Rotfuks commented Jan 15, 2024

For the internal use case we now have the document describing our release framework.
The most relevant part in there for customers is the part about applying the cluster- chart to create and update clusters. Since we will have a follow up ticket to implement the documented target state, we will create public customer facing documentation on that updated state once we reach it and customers can actually use it.
So at this stage I'm rescoping this issue to focus on the public customer facing documentation only and move it to the epic for the implementation of the framework.

@Rotfuks
Copy link
Contributor

Rotfuks commented Jan 17, 2024

Story will be done in the scope of these user stories: #3140
Additional we will work on a workbook documenting a list of How-Tos around the document of the release process here: #3143

Currently we don't have additional public documents from the release framework yet.

@Rotfuks Rotfuks closed this as completed Jan 17, 2024
@teemow
Copy link
Member Author

teemow commented Jan 17, 2024

@Rotfuks just fyi. We are planning to do a bigger effort on the docs to reflect all the changes with CAPI. Upgrades and releases need to be part of this as well and your teams help is needed there. I'll coordinate this with @pipo02mix

@Rotfuks
Copy link
Contributor

Rotfuks commented Jan 22, 2024

Makes sense! As we already split this ticket in a documentation (or extension of the documentation) per provider we have already some work planned in, but we sure can improve the docs on some other positions as well :)

@pipo02mix
Copy link
Contributor

The plan is next week work on the layout of the docs to be CAPI-ready. We have a SIG docs in 2 weeks, I would recommend you (or another turtle) to attend so I can present you the plan and we can discuss your ideas

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/kaas Mission: Cloud Native Platform - Self-driving Kubernetes as a Service team/turtles Team Turtles
Projects
Archived in project
Development

No branches or pull requests

6 participants