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

Add table of with status of SCS standards #29

Closed
anjastrunk opened this issue Apr 25, 2023 · 9 comments
Closed

Add table of with status of SCS standards #29

anjastrunk opened this issue Apr 25, 2023 · 9 comments

Comments

@anjastrunk
Copy link
Contributor

As a user, I want to see the current status of SCS standards. Copy tables form slide 17 - 25 to docs repo.

@mbuechse
Copy link
Contributor

Current development happens inside HedgeDoc.
The guide tells us where to place documentation. Still unsure where to put it. @garloff What do you think?

@garloff
Copy link
Member

garloff commented Apr 27, 2023

My suggestion would be to add an issues to the Standards repo to track each standardization line from the slides. Note that some already exist!
A master issue that links the others would be useful. (Use - [ ] syntax.)
Standards are Drafted as md docs in the standards repo.
The SCS docs page can include docs from various repos, including the standards.

@fkr
Copy link
Member

fkr commented Apr 27, 2023

A master issue that links the others would be useful. (Use - [ ] syntax.)

I'd suggest to make an epic that contains each standard as a story.
Definition of Done for the epic contains of that said list (that contains the stories).

@mbuechse
Copy link
Contributor

mbuechse commented Apr 27, 2023

So, if I understand your proposals correctly: both of you suggest to use one issue per row of the table; sometimes such an issue already exists, sometimes it needs to be created. Moreover, we might use (1) a master issue with tasks corresponding to these aforementioned issues or (2) an epic linking these issues. Now another option occurs to me: (3) tag the issues and use the board to track them -- in fact, one such board already seems to exist: https://github.com/orgs/SovereignCloudStack/projects/6/views/23?layout=board
edit one might also filter for the "standards" label instead of "SCS is standardized": https://github.com/orgs/SovereignCloudStack/projects/6/views/23?layout=board&filterQuery=label%3A%22standards%22
I'm not quite sure which is the correct one.
edit 2: there is a third label called "standardization": https://github.com/SovereignCloudStack/issues/labels/standardization
It seems to be used only three times, always in conjunction with one of the other two.

Questions:
How do you like this third option?
Is the board the right one, or would we use/create another one?

Also, I suppose we should keep these issues up to date, referencing any relevant documents, issues, discussions etc., so as to have a single source sink of truth?

@maxwolfs
Copy link
Member

maxwolfs commented May 8, 2023

There is also this issue within the docs-page repository with the aim of an interactive overview of available, I'm currently on: #60
Feedback welcomed! :)

(going back to this one: SovereignCloudStack/standards#86)

@mbuechse
Copy link
Contributor

mbuechse commented May 8, 2023

@maxwolfs Thanks for pointing me to this issue. If I understand correctly, the aim is to convert the YAML file(s) into an interactive diagram, which I do like. I think the epic that @fkr suggested would be a good place for organizing the to-dos, whereas the diagram would mainly show what's already done, right?

BTW, I just noticed that the YAML claims that V2 of "SCS compatible" (a) has been stabilized on 2023-03-23 and (b) it contains the flavor naming standard. However, the latter standard hasn't been stabilized yet. @garloff Is that a contradiction, or are these different concepts of stabilization? (NB I don't mean to be nitpicking here; I'm still familiarizing myself with the topic, and as yet I can't tell with certainty what's problematic and what isn't.)

@maxwolfs
Copy link
Member

@maxwolfs Thanks for pointing me to this issue. If I understand correctly, the aim is to convert the YAML file(s) into an interactive diagram, which I do like. I think the epic that @fkr suggested would be a good place for organizing the to-dos, whereas the diagram would mainly show what's already done, right?

Yes, you are correct.

@mbuechse
Copy link
Contributor

I tried to start an epic, but all I can do at the moment is write plain issues; I can't assign labels or anything. The result so far is here: SovereignCloudStack/standards#285
This issue is about the IaaS track; I will add a corresponding issue for KaaS soon.
Existing standards would be tracked via #60
So I suppose this issue can indeed be closed now (I don't seem to be authorized to do so).

@mbuechse
Copy link
Contributor

Will be covered via

garloff pushed a commit that referenced this issue Aug 28, 2023
* add cleanup step

Signed-off-by: maxwolfs <[email protected]>

* remove standards from docs

Signed-off-by: maxwolfs <[email protected]>

---------

Signed-off-by: maxwolfs <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants