-
Notifications
You must be signed in to change notification settings - Fork 788
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
Add server_config.json reference page #4274
base: develop
Are you sure you want to change the base?
Conversation
| [mongodb](#mongodb) | Merged | Optional | cannot be null | | ||
| [ssl\_certificate](#ssl_certificate) | Merged | Optional | cannot be null | |
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.
We need to decide how to address these.
They're shown this way because these fields in IslandConfigOptions
expect another pydantic model as the value, i.e., they have additional properties in the schema.
My plan ATM is to declare the type as object
for these fields and add a "properties" field in the explanation (see c6baabc).
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.
Should we mention that this configuration is used for the server_config.json
, or is this linked from another page that makes that connection?
|
||
* is optional | ||
|
||
* Type: `string` |
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.
Should we list the acceptable values?
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.
We don't have any constraints on the value in the code. It doesn't make sense to add it ourselves in the reference documentation.
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.
It might be worth adding the constraints in the code.
#### ssl\_certificate Properties | ||
**_ssl\_certificate\_file_** |
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 think we should nix the header at this level and do #### ssl_certificate_file
and #### ssl_certificate_key_file
. At the top level, there's no header for "properties". In other words, Under ## Configuration
there is not ### Configuration Properties
.
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.
Same for mongo.
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.
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.
You could omit "mongodb Default value". All of mongodb
's properties have default values, so you can extrapolate the default value of the whole object from there. You could also provide an example of the whole file in a different subsection at the same level as ### Configuration Properties
.
This is a reference page so I don't think we need that kind of information here. We'll have all those details and a link to this page in the features page. |
What does this PR do?
Fixes #4216
PR Checklist
Testing Checklist