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

chore: add additional document statuses #139

Merged
merged 5 commits into from
Oct 12, 2022
Merged

chore: add additional document statuses #139

merged 5 commits into from
Oct 12, 2022

Conversation

toddbaert
Copy link
Member

@toddbaert toddbaert commented Sep 22, 2022

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 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
Copy link
Contributor

@dyladan dyladan left a comment

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

specification/README.md Outdated Show resolved Hide resolved
specification/README.md Outdated Show resolved Hide resolved
specification/README.md Outdated Show resolved Hide resolved
specification/README.md Outdated Show resolved Hide resolved
Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>
Signed-off-by: Todd Baert <toddbaert@gmail.com>
Copy link
Member

@agentgonzo agentgonzo left a comment

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
Copy link
Member Author

toddbaert commented Sep 28, 2022

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

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
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
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

Signed-off-by: Todd Baert <toddbaert@gmail.com>
Signed-off-by: Todd Baert <toddbaert@gmail.com>
specification/README.md Outdated Show resolved Hide resolved
Signed-off-by: Todd Baert <toddbaert@gmail.com>
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.

None yet

8 participants