docs icon indicating copy to clipboard operation
docs copied to clipboard

Missing documentation for valid enum value bullets

Open joeduffy opened this issue 4 years ago • 1 comments

We are missing valid values for the mfaConfigurations options on this resource: https://www.pulumi.com/docs/reference/pkg/aws/cognito/userpool/#inputs.

It trails off after "Valid values:":

image

The corresponding source documentation is here: https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/cognito_user_pool.markdown:

* `mfa_configuration` - (Optional) Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values:
    * `OFF` - MFA tokens are not required.
    * `ON` - MFA is required for all users to sign in. Requires at least one of `sms_configuration` or `software_token_mfa_configuration` to be configured.
    * `OPTIONAL` - MFA will be required only for individual users who have MFA enabled. Requires at least one of `sms_configuration` or `software_token_mfa_configuration` to be configured.

I assume we're not properly parsing the indented sub-bullets.

I wasn't sure if there was an existing item tracking this -- if so, please dupe.

joeduffy avatar May 05 '20 22:05 joeduffy

Is this because we're missing some "continuation phrases" to match on in this section?

https://github.com/pulumi/pulumi-terraform-bridge/blob/30d7d6a046545b1226f2e1b81f22bab4b3181b96/pkg/tfgen/docs.go#L263-L272

ex: The create_option property here would need to match on "values include" maybe?

gpduck avatar Aug 04 '20 03:08 gpduck

This is fixed in current docs.

lukehoban avatar Dec 30 '22 02:12 lukehoban