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

Add server_config.json reference page #4274

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

Conversation

shreyamalviya
Copy link
Contributor

What does this PR do?

Fixes #4216

PR Checklist

  • Have you added an explanation of what your changes do and why you'd like to include them?
  • Is the TravisCI build passing?
  • Was the CHANGELOG.md updated to reflect the changes?
  • Was the documentation framework updated to reflect the changes?
  • Have you checked that you haven't introduced any duplicate code?

Testing Checklist

  • Added relevant unit tests?
  • Do all unit tests pass?
  • Do all end-to-end tests pass?
  • Any other testing performed?

    Tested by {Running the Monkey locally with relevant config/running Island/...}

  • If applicable, add screenshots or log transcripts of the feature working

Comment on lines 22 to 23
| [mongodb](#mongodb) | Merged | Optional | cannot be null |
| [ssl\_certificate](#ssl_certificate) | Merged | Optional | cannot be null |
Copy link
Contributor Author

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).

@shreyamalviya shreyamalviya marked this pull request as ready for review August 13, 2024 14:53
Copy link
Contributor

@cakekoa cakekoa left a 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`
Copy link
Contributor

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?

Copy link
Contributor Author

@shreyamalviya shreyamalviya Aug 14, 2024

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.

Copy link
Collaborator

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.

Comment on lines 130 to 131
#### ssl\_certificate Properties
**_ssl\_certificate\_file_**
Copy link
Collaborator

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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for mongo.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks mostly fine to me except that "start_mongodb" and "mongodb Default Value" are both h4.
image

Copy link
Collaborator

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.

@shreyamalviya
Copy link
Contributor Author

Should we mention that this configuration is used for the server_config.json, or is this linked from another page that makes that connection?

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.

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.

Add server_config.json reference documentation
3 participants