-
Notifications
You must be signed in to change notification settings - Fork 196
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
Include hand crafted resources in documentation indexes #3055
Include hand crafted resources in documentation indexes #3055
Conversation
Don't want enforcement here as we are using some values later on in the pipeline.
Codecov Report
@@ Coverage Diff @@
## main #3055 +/- ##
==========================================
- Coverage 54.27% 54.26% -0.02%
==========================================
Files 1379 1379
Lines 596286 596347 +61
==========================================
- Hits 323664 323605 -59
- Misses 219482 219575 +93
- Partials 53140 53167 +27
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall LGTM. One question is if there's a way for us to detect that somebody has forgotten to include a handcrafted resource in the azure-arm.yaml
file?
Doesn't necessarily have to be part of the code generator (in fact in some ways that'd be sorta weird). Maybe some way to write a taskfile target that verifies this?
The more I think about it the more I wonder if we should split the doc generation out into a different tool that does something based more on the filesystem (which would then work more easily for handcrafted resources as they also exist on the filesystem)... something to think about longer term possibly.
@@ -938,6 +938,9 @@ objectModelConfiguration: | |||
$exportAs: Database | |||
$supportedFrom: v2.0.0-beta.1 | |||
dbformysql: | |||
v1: # Handcrafted |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have a way to detect if we've forgotten to add this?
There was a problem hiding this 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 at the moment. I'll give that some thought though.
What this PR does / why we need it:
Our index pages need to include any hand-crafted types that we add to ASO; without them, the documentation (which we are generating) can't be easily found.
Closes #3054
How does this PR make you feel:
If applicable: