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

Write ADR on the status page api #237

Closed
9 tasks
fkr opened this issue Dec 15, 2022 · 2 comments
Closed
9 tasks

Write ADR on the status page api #237

fkr opened this issue Dec 15, 2022 · 2 comments
Labels
Ops Issues or pull requests relevant for Team 3: Ops Tooling standards Issues / ADR / pull requests relevant for standardization & certification status-page
Milestone

Comments

@fkr
Copy link
Member

fkr commented Dec 15, 2022

As the SCS project we want to write a standard for the status page API.
This should be a very lean document that:

  • contains a pointer to the ADR on the decisions that were taken for the development
  • contains a pointer to the OpenAPI spec

Definition of Ready:

  • User Story is small enough to be finished within one sprint
  • User Story is clear and understood by the whole team
  • Acceptance criteria are defined
  • Acceptance criteria are clear and understood by the whole team

Definition of Done:

  • All acceptance criteria are met
  • Changes have been reviewed
  • CI tests have run successfully
  • Documentation has been updated
  • Release Notes have been updated
@fkr fkr added Ops Issues or pull requests relevant for Team 3: Ops Tooling needs refinement User stories that need to be refined for further progress status-page standards Issues / ADR / pull requests relevant for standardization & certification labels Dec 15, 2022
@fkr fkr added this to the R4 (v5.0.0) milestone Dec 15, 2022
@fkr fkr removed the needs refinement User stories that need to be refined for further progress label Jan 9, 2023
@tibeer tibeer mentioned this issue Mar 29, 2023
@bitkeks
Copy link
Member

bitkeks commented Feb 14, 2024

In Ops call 2024-02-08 we discussed this issue and were wondering if it can be re-activated. There seems to be content

However, Standard SCS-0402-v1 (https://github.com/SovereignCloudStack/standards/blob/main/Standards/scs-0402-v1-status-page-openapi-spec-decision.md) currently only seems to contain the decisions regarding OpenAPI, not the Status Page API itself.

@fkr should we revisit this issue?

@fkr
Copy link
Member Author

fkr commented Feb 22, 2024

While I actually thought it would add value (this is why I created the issue back in 2022), I doubt it adds any real value. The design considerations can be pulled from the OpenAPI spec and honestly there is no need to bloat this up.
I'd say: just close.

@bitkeks bitkeks closed this as completed Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Ops Issues or pull requests relevant for Team 3: Ops Tooling standards Issues / ADR / pull requests relevant for standardization & certification status-page
Projects
Status: Done
Development

No branches or pull requests

2 participants