Skip to content

chore: add additional document statuses#139

Merged
toddbaert merged 5 commits into
mainfrom
doc-statuses
Oct 12, 2022
Merged

chore: add additional document statuses#139
toddbaert merged 5 commits into
mainfrom
doc-statuses

Conversation

@toddbaert

@toddbaert toddbaert commented Sep 22, 2022

Copy link
Copy Markdown
Member

Adds document statuses explaining stability of various spec documents and sub-sections.

This is important as we move toward's 1.0 SDK releases and a stable spec.

@toddbaert toddbaert requested a review from beeme1mr September 22, 2022 19:07
@toddbaert toddbaert marked this pull request as draft September 22, 2022 19:07
@toddbaert toddbaert force-pushed the doc-statuses branch 2 times, most recently from c542d42 to b5d363a Compare September 22, 2022 19:11
@beeme1mr beeme1mr requested a review from dyladan September 22, 2022 19:20

@dyladan dyladan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall looks good. made a few minor comments

Comment thread specification/README.md Outdated
Comment thread specification/README.md Outdated
Comment thread specification/README.md Outdated
Comment thread specification/README.md Outdated
Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>
Signed-off-by: Todd Baert <toddbaert@gmail.com>

@agentgonzo agentgonzo left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure the benefit of Mixed, but it's not like it's a problem

@toddbaert

toddbaert commented Sep 28, 2022

Copy link
Copy Markdown
Member Author

I'm not sure the benefit of Mixed, but it's not like it's a problem

Ya I was hesitant about Mixed. It's not really a meaningful status unto itself, but more of a meta-status. I feel confident about the rest.

TBH we can probably completely remove it. We can annotate sections with statuses, it just means you'll have navigate to them to see them.

@InTheCloudDan

Copy link
Copy Markdown

Is there going to be requirements or guidelines on how the promotion is determined? For example what is required to go from Experimental -> Hardening?

@toddbaert

Copy link
Copy Markdown
Member Author

Is there going to be requirements or guidelines on how the promotion is determined? For example what is required to go from Experimental -> Hardening?

@InTheCloudDan that's a good question. I think some kind of formality could be good. I'm not sure what that could be. I'll think about it 🤔

Anyone else have ideas for this?

Signed-off-by: Todd Baert <toddbaert@gmail.com>
@toddbaert

Copy link
Copy Markdown
Member Author
  • added simple summary statements
  • added recommendations about prod usage
  • added statement describing that the TSC approves graduation:

It is the responsibility of the Technical Steering Committee to consider and approve the graduation of documents.

@InTheCloudDan @AloisReitbauer

@toddbaert toddbaert closed this Oct 5, 2022
@toddbaert toddbaert reopened this Oct 5, 2022
@toddbaert toddbaert closed this Oct 5, 2022
@toddbaert toddbaert reopened this Oct 5, 2022
Signed-off-by: Todd Baert <toddbaert@gmail.com>
Signed-off-by: Todd Baert <toddbaert@gmail.com>
Comment thread specification/README.md Outdated
Signed-off-by: Todd Baert <toddbaert@gmail.com>
@toddbaert toddbaert requested a review from kinyoklion October 12, 2022 17:59
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

Successfully merging this pull request may close these issues.

8 participants