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.

Sign up for GitHub

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

Jump to bottom

xActiveDirectory: Default values on parameters should be reflected in parameter description #426

Closed
johlju opened this issue Jul 11, 2019 · 0 comments · Fixed by #428
Closed

xActiveDirectory: Default values on parameters should be reflected in parameter description #426

johlju opened this issue Jul 11, 2019 · 0 comments · Fixed by #428
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub
Projects
All issues and PR's Remove 'x' from module name

Comments

@johlju
Copy link
Member

johlju commented Jul 11, 2019

If there are default values on parameters they should be reflected in the schema.mof parameter description so the Wiki gets updated with this information. This helps user to know if there is a need to provide a value for certain properties.

For example on Ensure property is should say Defaults to 'Present'. (if that is true).
@johlju johlju added this to To do in All issues and PR's via automation Jul 11, 2019
@johlju johlju added this to To do in Remove 'x' from module name via automation Jul 11, 2019
@johlju johlju added documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub in progress The issue is being actively worked on by someone. labels Jul 11, 2019
@johlju johlju moved this from To do to In progress in Remove 'x' from module name Jul 11, 2019
@johlju johlju mentioned this issue Jul 11, 2019
Merged
9 tasks
All issues and PR's automation moved this from To do to Done Jul 12, 2019
Remove 'x' from module name automation moved this from In progress to Done Jul 12, 2019
johlju added a commit that referenced this issue Jul 12, 2019
@johlju
xActiveDirectory: Fix various documentation issues (#428)
df33929 
- Changes to xActiveDirectory
  - Style guideline cleanup.
      - All localized strings in the resources now has a string ID suffix (issue #419).
      - All schema properties description now ends with full stop (.) (issue #420).
      - Updated all types in the resources schema to use PascalCase.
    - Updated all resource read-only parameters to start the description
      with 'Returns...' so it is more clear that the property cannot be
      assigned a value.
    - The default value on resource parameters are now reflected in the parameter
      descriptions in the schema.mof (so that Wiki will be updated) (issue #426).
- Changes to xADServicePrincipalName
  - Minor change to the unit tests that did not correct assert the localized
    string when an account is not found.
@johlju johlju removed the in progress The issue is being actively worked on by someone. label Jul 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub
Projects
All issues and PR's
  
Done
Remove 'x' from module name
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

xActiveDirectory: Fix various documentation issues johlju/ActiveDirectoryDsc
1 participant
@johlju