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

docs: write use case integration guide #92

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ferrarimarco
Copy link
Member

No description provided.

@ferrarimarco ferrarimarco self-assigned this Jan 15, 2025
@arueth
Copy link
Collaborator

arueth commented Jan 15, 2025

Can we move this out to a DEVELOPER.md or CONTRIBUTING.md file? I think it would be good to keep the README.md file as a TOC with descriptions for the use cases.

@ferrarimarco
Copy link
Member Author

Can we move this out to a DEVELOPER.md or CONTRIBUTING.md file? I think it would be good to keep the README.md file as a TOC with descriptions for the use cases.

Done

@arueth
Copy link
Collaborator

arueth commented Jan 16, 2025

You can keep it in the platforms/gke/base/use-cases directory or you'll need to state "on the GKE Base Platform". At some point we will also add additional platforms.

It would probably be better to keep it in the use-cases folder and link to it from the main CONTRIBUTING.md file.

@ferrarimarco
Copy link
Member Author

Makes sense. Moved to platforms/gke/base/use-cases/DEVELOPER.md

@arueth
Copy link
Collaborator

arueth commented Jan 17, 2025

Did you want to add a line to the /CONTRIBUTING.md and/or platforms/gke/base/use-cases/README.md with a link to this?

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.

2 participants