-
Notifications
You must be signed in to change notification settings - Fork 166
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
chore: Define default resource and data source documentation template #1847
Conversation
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.
A small detail
# Import | ||
## Add the import | ||
|
||
For more information see: [MongoDB Atlas API - Search Node](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Atlas-Search/operation/createAtlasSearchDeployment) 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.
I believe we can remove this from the default template right? Not sure if we are capable of leaving this generic. Applies to the data source template as well.
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 believe we can remove this from the default template right? Not sure if we are capable of leaving this generic.
we can have the import autogenerated if we define an import.txt
in the example folder. similar to https://github.com/mongodb/terraform-provider-mongodbatlas/pull/1394/files#diff-ab6cba42e3e4a9f3642faec48e42d41f668902c8ffa3041a36bbc56e01c59913. What do you think?
applies to the data source template as well.
data sources do not have the import
Description
Ticket: https://jira.mongodb.org/browse/CLOUDP-222897
Context:
Proposed Solution:
For documentation that requires no specific changes the default template can be used and no new template needs to be created. In case specific adjustments are needed, the default template will serve as a starting point to define the new template.
Type of change:
Required Checklist:
Testing
I ran
export resource_name=cluster && make generate-doc
and chcke that the default template was used.