[DOCS] Update the auto YAML Generation #7725
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
unsur eif schema./yaml is maintained or auto generated.
Contributor
Author
|
@mindspank thoughts on this PR?
If approved, ill go back in and overwrite /reference/project-files/ and fix any broken links |
Contributor
|
@royendo , we prefer using a single file instead of using imports — like in this example, where everything is in one file. Initially, I had created separate files and imported them into project.schema.yaml, like you did, but @begelundmuller suggested keeping everything in one file. |
NamanMahor
requested changes
Aug 6, 2025
all schemas into one including rillyaml. commented out lines. reworked generate-project.go: - moved out logic for sample in copy, uses schema sample instead - adding in line examples
NamanMahor
requested changes
Aug 21, 2025
| - $ref: '#/definitions/model' | ||
| - $ref: '#/definitions/theme' | ||
| - $ref: '#/definitions/connectors' | ||
| - $ref: '#/definitions/sources' |
Contributor
There was a problem hiding this comment.
I think we should remove source too? As sidd mentioned lesser pages the better
royendo
changed the title
NamanMahor
reviewed
Aug 22, 2025
NamanMahor
reviewed
Aug 22, 2025
NamanMahor
reviewed
Aug 28, 2025
NamanMahor
reviewed
Aug 28, 2025
NamanMahor
approved these changes
Aug 28, 2025
Co-authored-by: Naman Mahor <[email protected]>
grahamplata
pushed a commit
that referenced
this pull request
Sep 6, 2025
* some changes for connector YAML unsur eif schema./yaml is maintained or auto generated. * remove * separated YAML schema * nit * link fixes * Update generate_project.go * add sec warning * motherduck live connector * remove local file from connector * nit * matching file names * reordered files and added sources YAML and model SQL * nit, fix links * comparing with current YAML changes * adding annotatons back * gofmt, golint * fix * first pass fix, need to review a few other items * remove toplevel driver * single project file all schemas into one including rillyaml. commented out lines. reworked generate-project.go: - moved out logic for sample in copy, uses schema sample instead - adding in line examples * Update generate_project.go * good old cursor wiped my functoni * missing parameters * midding parameters and inline examples * god so many false positives from asking cursor to merge files * adding links * fixed oneOf * split data properties to have api excamples * gonig through files * returning original format next will be adding more examples * ? * fixing urls, * apis fix * formattnig * separated rill yaml, adv from rest, #### to ###, added component back * examples * https://rilldata.slack.com/archives/C07R1EP2CCV/p1754929153966689 makes more sense, less duplicate info * fixing examples confirm yaml, comment out sources "/Users/royendo/Desktop/GitHub/rill/runtime/parser/schema/project.schema.yaml": [ "alerts/**/*.yaml", "apis/**/*.yaml", "connectors/**/*.yaml", "dashboards/**/*.yaml", "metrics/**/*.yaml", "models/**/*.yaml", // "sources/**/*.yaml" ] } * overwrite /reference/project-files and fixing links * type and fix links, add openai connector * gm fmt and lint * prettier and lint * Update docusaurus.config.js * advanced-model to model * ready to check * adding schema_name for MD * as requested * fix links * golang lint * no more type error * last touches and requests * Update apis.md * lint fix * remove commented code * Update Makefile Co-authored-by: Naman Mahor <[email protected]> * Update generate_project.go * lint * Update generate_project.go --------- Co-authored-by: Naman Mahor <[email protected]>
kaspersjo
pushed a commit
that referenced
this pull request
Sep 11, 2025
* some changes for connector YAML unsur eif schema./yaml is maintained or auto generated. * remove * separated YAML schema * nit * link fixes * Update generate_project.go * add sec warning * motherduck live connector * remove local file from connector * nit * matching file names * reordered files and added sources YAML and model SQL * nit, fix links * comparing with current YAML changes * adding annotatons back * gofmt, golint * fix * first pass fix, need to review a few other items * remove toplevel driver * single project file all schemas into one including rillyaml. commented out lines. reworked generate-project.go: - moved out logic for sample in copy, uses schema sample instead - adding in line examples * Update generate_project.go * good old cursor wiped my functoni * missing parameters * midding parameters and inline examples * god so many false positives from asking cursor to merge files * adding links * fixed oneOf * split data properties to have api excamples * gonig through files * returning original format next will be adding more examples * ? * fixing urls, * apis fix * formattnig * separated rill yaml, adv from rest, #### to ###, added component back * examples * https://rilldata.slack.com/archives/C07R1EP2CCV/p1754929153966689 makes more sense, less duplicate info * fixing examples confirm yaml, comment out sources "/Users/royendo/Desktop/GitHub/rill/runtime/parser/schema/project.schema.yaml": [ "alerts/**/*.yaml", "apis/**/*.yaml", "connectors/**/*.yaml", "dashboards/**/*.yaml", "metrics/**/*.yaml", "models/**/*.yaml", // "sources/**/*.yaml" ] } * overwrite /reference/project-files and fixing links * type and fix links, add openai connector * gm fmt and lint * prettier and lint * Update docusaurus.config.js * advanced-model to model * ready to check * adding schema_name for MD * as requested * fix links * golang lint * no more type error * last touches and requests * Update apis.md * lint fix * remove commented code * Update Makefile Co-authored-by: Naman Mahor <[email protected]> * Update generate_project.go * lint * Update generate_project.go --------- Co-authored-by: Naman Mahor <[email protected]>
kaspersjo
pushed a commit
that referenced
this pull request
Oct 7, 2025
* some changes for connector YAML unsur eif schema./yaml is maintained or auto generated. * remove * separated YAML schema * nit * link fixes * Update generate_project.go * add sec warning * motherduck live connector * remove local file from connector * nit * matching file names * reordered files and added sources YAML and model SQL * nit, fix links * comparing with current YAML changes * adding annotatons back * gofmt, golint * fix * first pass fix, need to review a few other items * remove toplevel driver * single project file all schemas into one including rillyaml. commented out lines. reworked generate-project.go: - moved out logic for sample in copy, uses schema sample instead - adding in line examples * Update generate_project.go * good old cursor wiped my functoni * missing parameters * midding parameters and inline examples * god so many false positives from asking cursor to merge files * adding links * fixed oneOf * split data properties to have api excamples * gonig through files * returning original format next will be adding more examples * ? * fixing urls, * apis fix * formattnig * separated rill yaml, adv from rest, #### to ###, added component back * examples * https://rilldata.slack.com/archives/C07R1EP2CCV/p1754929153966689 makes more sense, less duplicate info * fixing examples confirm yaml, comment out sources "/Users/royendo/Desktop/GitHub/rill/runtime/parser/schema/project.schema.yaml": [ "alerts/**/*.yaml", "apis/**/*.yaml", "connectors/**/*.yaml", "dashboards/**/*.yaml", "metrics/**/*.yaml", "models/**/*.yaml", // "sources/**/*.yaml" ] } * overwrite /reference/project-files and fixing links * type and fix links, add openai connector * gm fmt and lint * prettier and lint * Update docusaurus.config.js * advanced-model to model * ready to check * adding schema_name for MD * as requested * fix links * golang lint * no more type error * last touches and requests * Update apis.md * lint fix * remove commented code * Update Makefile Co-authored-by: Naman Mahor <[email protected]> * Update generate_project.go * lint * Update generate_project.go --------- Co-authored-by: Naman Mahor <[email protected]>
| - name | ||
| additionalProperties: false | ||
| minItems: 1 | ||
| explore_properties: |
Contributor
There was a problem hiding this comment.
This had all the explore properties that can be set for explores defined inline under explore: in a metrics view (the properties here are subtlety different from those in the stand-alone explore resource).
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Separated the schema files for easier management
referenced in project.schema.yaml.
reworked connections to look similar to currrent with copiable form.
models.schema.yaml --> advanced-model.schema.yaml
once confirmed, we can move this to rewrite /reference/project--files/
Checklist: