prepare provider for tfplugindocs

[maksym-nazarenko]

Part of #82

[ddelnano]

username, password and host are not optional fields. So it seems like the provider's arguments aren't set correctly?

[maksym-nazarenko]

that's how it is declared:

"username": {
    Type:        schema.TypeString,
    Required:    true,
    DefaultFunc: schema.EnvDefaultFunc("MIKROTIK_USER", nil),
    Description: "User account for mikrotik api",
},

so yes, it should either be set to Optional or update the docs and mention that there is a fallback to env vars.

[ddelnano]

I'd like to merge this PR first so we can rebase the others to remove the shared changes. I had one question about why everything is considered optional, otherwise this looks good.

[maksym-nazarenko]

@ddelnano we can turn those fields into Required - the will be fetched from env if user does not provide them in configuration.

[ddelnano]

I see. I didn't realize that having the env in use would make these optional. Anyway, knowing that this is good as is.

[ddelnano]

@Maxim-Nazarenko please rebase the remaining doc update PRs and then we can get those merged.

[maksym-nazarenko]

@ddelnano I just relaised what you was referring to.
It was an issue in tfplugindocs which rendered fields in optional section regardless of Required: true attribute.
I'll update it in follow-up PR.
Never mind, it was my local issue: for some reason exactly that integrated terminal in VS Code was broken - tfplugindocs worked as expected everywhere except the opened terminal o_O. Had to close it and open again 🤷

Sharp eye!