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

README - Getting started #3117

Open
wants to merge 21 commits into
base: develop
Choose a base branch
from
Open

README - Getting started #3117

wants to merge 21 commits into from

Conversation

patel-bhavin
Copy link
Contributor

@patel-bhavin patel-bhavin commented Sep 4, 2024

Adding a getting started section
Quick start commands
Adding explanation for our yaml files

@patel-bhavin patel-bhavin added this to the v4.40.0 milestone Sep 4, 2024
@patel-bhavin patel-bhavin added the WIP DO NOT MERGE Work in Progress label Sep 4, 2024
@patel-bhavin patel-bhavin removed this from the v4.40.0 milestone Sep 5, 2024
@patel-bhavin patel-bhavin removed the WIP DO NOT MERGE Work in Progress label Sep 17, 2024
@patel-bhavin patel-bhavin added this to the v4.41.0 milestone Sep 17, 2024
@ljstella
Copy link
Contributor

Couple of questions:

  • Why are we putting them all in the readme.md as opposed to another file/folder and linking to it?
  • Do we think folks are going to continue to scroll that far to see them?
  • How will we ensure these stay up to date as the objects change?
  • There are several other constraints on several of the fields in many files, that we've not indicated in these tables- are we planning to expand this more later, or just rely on validation failures to guide folks along?

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