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

Initial GAMMA docs take #2238

Merged
merged 14 commits into from
Aug 4, 2023
Merged

Conversation

kflynn
Copy link
Contributor

@kflynn kflynn commented Jul 26, 2023

Initial cut of GAMMA website updates

Signed-off-by: [email protected]

/kind documentation

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 26, 2023
@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 26, 2023
@kflynn kflynn marked this pull request as draft July 26, 2023 18:37
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 26, 2023
Copy link
Contributor

@howardjohn howardjohn left a comment

Choose a reason for hiding this comment

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

This is awesome 👍 👍

I left a bunch of nitpicks, nothing blocking at all though

site-src/concepts/api-overview.md Outdated Show resolved Hide resolved
site-src/concepts/api-overview.md Outdated Show resolved Hide resolved
site-src/concepts/api-overview.md Outdated Show resolved Hide resolved
site-src/concepts/api-overview.md Outdated Show resolved Hide resolved
site-src/concepts/glossary.md Outdated Show resolved Hide resolved
site-src/concepts/glossary.md Show resolved Hide resolved
site-src/concepts/service-facets.md Outdated Show resolved Hide resolved
Copy link
Contributor

@youngnick youngnick left a comment

Choose a reason for hiding this comment

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

This is looking great, nice work @kflynn.

The big question I have though is: do we have a backup plan for if we have to pivot away from Service binding? This PR effectively cements Service binding as the future, and if we change our mind, it will get fiddly.

I guess I'm really asking: at this point, is there any possibility we will use something other than Service binding as the main east/west approach?

If not, awesome, we're good.

If there is even a slim chance, we may need to put some more callouts and caveats that the service binding approach is still experimental and could change.

Like I said in one of my comments, I really want to avoid another Policy Attachment error - where the docs accidentally make something look more stable than it actually is.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 27, 2023
Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

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

Thanks for all the work on this @kflynn! This is really great!

site-src/index.md Outdated Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
site-src/concepts/roles-and-personas.md Outdated Show resolved Hide resolved
site-src/concepts/use-cases.md Outdated Show resolved Hide resolved
site-src/concepts/use-cases.md Outdated Show resolved Hide resolved
site-src/implementations.md Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
site-src/concepts/glossary.md Outdated Show resolved Hide resolved
site-src/concepts/api-overview.md Show resolved Hide resolved
@kflynn kflynn force-pushed the flynn/gamma-docs branch from 70f4fe4 to 3f90fd6 Compare July 27, 2023 01:50
@k8s-ci-robot k8s-ci-robot added do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 27, 2023
@kflynn kflynn force-pushed the flynn/gamma-docs branch from 3f90fd6 to d404798 Compare July 27, 2023 02:03
@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. labels Jul 27, 2023
@kflynn
Copy link
Contributor Author

kflynn commented Jul 28, 2023

I think feedback other than renaming Charlie to Chihiro has been addressed in the current commits -- commenters (@youngnick, @robscott, @howardjohn) please check to see that things look good to you! Since I've pointed to specific commits in comments, I'll rebase after folks take a look. 🙂

@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 28, 2023
@kflynn kflynn force-pushed the flynn/gamma-docs branch from d729b6b to 6215138 Compare July 31, 2023 21:08
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 31, 2023
@kflynn kflynn marked this pull request as ready for review July 31, 2023 21:09
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 31, 2023
@kflynn
Copy link
Contributor Author

kflynn commented Jul 31, 2023

I've marked this ready for review since I think we're pretty close at this point.

@youngnick
Copy link
Contributor

This LGTM, and is an excellent addition. Thanks @kflynn!

/approved
/hold
for further review

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 2, 2023
@keithmattix
Copy link
Contributor

Love this! Thanks flynn
/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 3, 2023
@keithmattix
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 3, 2023
@keithmattix
Copy link
Contributor

I think @youngnick meant /approve

@youngnick
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: keithmattix, kflynn, youngnick

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 4, 2023
@k8s-ci-robot k8s-ci-robot merged commit aef23fb into kubernetes-sigs:main Aug 4, 2023
@kflynn kflynn deleted the flynn/gamma-docs branch August 16, 2023 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants