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

AzureDevOpsDsc: Built module contain folder 'Examples' #11

Closed
johlju opened this issue Jan 24, 2021 · 1 comment · Fixed by #28
Closed

AzureDevOpsDsc: Built module contain folder 'Examples' #11

johlju opened this issue Jan 24, 2021 · 1 comment · Fixed by #28
Labels
enhancement The issue is an enhancement request.

Comments

@johlju
Copy link
Member

johlju commented Jan 24, 2021

We should remove the entry Examples from here:

AzureDevOpsDsc/build.yaml

Lines 5 to 9 in 8d43d12

CopyPaths:
- Classes
- en-US
- Examples
- Modules

Examples should be avoided to pass in the built module to minimize the size of the package that is distributed. Examples should be added automatically into the resource conceptual help.

DscResource.DocGenerator has as build task for this Generate_Conceptual_Help but should be learned how to generate conceptual help for class-based resources if it only know how to do it for MOF-based resource.
@johlju johlju added enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community. labels Jan 24, 2021
SphenicPaul added a commit to SphenicPaul/AzureDevOpsDsc that referenced this issue Jan 28, 2021
@SphenicPaul
Updated 'CHANGELOG.md' with issues dsccommunity#10 (removing 'Classes…
f5adcb9 
…' directory) and dsccommunity#11 (removing 'Examples' directory).
@SphenicPaul SphenicPaul mentioned this issue Jan 28, 2021
Merged
9 tasks
@SphenicPaul
Copy link
Contributor

I've added issue #51 in DscResource.DocGenerator project.

I'm trying to close this issue (within PR #28) with just the removal of the Examples directory but I'll update #15 to ensure "Examples" are included in that issue and add a reference to the above, DscResource.DocGenerator issue.

@SphenicPaul SphenicPaul mentioned this issue Jan 28, 2021
Closed
johlju pushed a commit that referenced this issue Jan 29, 2021
@SphenicPaul
AzureDevOpsDsc: Increase Azure DevOps API timeout and other minor fix…
f1d8097 
…es (#28)

- AzureDevOpsDsc
    - Increased Azure DevOps, API timeout to 5 minutes to allow for busy/slow API
      operations (issue #25).
    - Updated contextual help (issue #5).
    - Removed `Classes` directory from being output in packaged module (issue #10).
    - Removed `Examples` directory from being output in packaged module (issue #11).
    - Moved 'Ensure' and 'RequiredAction' enums into 'Enum' directory and out of
      'prefix.ps1' (issue #12).
@johlju johlju removed the help wanted The issue is up for grabs for anyone in the community. label Jan 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement The issue is an enhancement request.
Projects
None yet
Milestone
No milestone
2 participants
@johlju @SphenicPaul