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.

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

Creating convention for Azure templates based on directory structure #43

Closed
BernieWhite opened this issue Feb 16, 2021 · 0 comments · Fixed by #58
Closed

Creating convention for Azure templates based on directory structure #43

BernieWhite opened this issue Feb 16, 2021 · 0 comments · Fixed by #58
Assignees
Labels
enhancement New feature or request feature: conventions Issues that affect PSDocs conventions
Milestone

Comments

@BernieWhite
Copy link
Contributor

PSDocs conventions are a feature added to PSDocs v0.8.0.

Conventions allow automatic naming of output documents.

Currently we have a manual sample (below) to name documents based on their directory structure.

# Generate a standard name of the markdown file. i.e. <name>_<version>.md
$template = Get-Item -Path $_.TemplateFile;
$templateName = $template.Directory.Parent.Name;
$version = $template.Directory.Name;
$docName = "$($templateName)_$version";

This can now be converted to a convention to avoid using extra code for common scenarios.

@BernieWhite BernieWhite added enhancement New feature or request feature: conventions Issues that affect PSDocs conventions labels Feb 16, 2021
@BernieWhite BernieWhite added this to the v0.3.0 milestone Feb 25, 2021
@BernieWhite BernieWhite self-assigned this Feb 25, 2021
BernieWhite added a commit that referenced this issue Mar 13, 2021
#58)

* Added support for naming document by parent path using conventions #43

* Added updates based on feedback
@BernieWhite BernieWhite mentioned this issue May 12, 2021
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature: conventions Issues that affect PSDocs conventions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant