Get-KCArticleReport.ps1

<#
    .SYNOPSIS
        Creates a CSV file containing details of each article in the knowledge center.

    .DESCRIPTION
        Creates a CSV file containing details of each article in the knowledge center. Returns product, article title, category, link,
        last modified date and creation date.

    .PARAMETER DocumentationFolder
        The folder of the documentation repository.

    .PARAMETER DestinationFolder
        The folder in which to store the output CSV.

    .EXAMPLE
        Get-KCArticleReport.ps1 -DocumentationFolder "C:\documentation" -DestinationFolder "C:\temp"

    .EXAMPLE
        Get-KCArticleReport.ps1 -DocumentationFolder <repository folder path> -DestinationFolder <csv output folder>

#>

[CmdletBinding()]
param (
    [Parameter(Mandatory = $true)]
    [ValidateScript({ if (-not (Test-Path -Path $_)) { throw "Folder path does not exist" } else { if (-not (Test-Path -Path "$_\articles")) { throw "Folder specified is not the documentation folder" } else { $true } } })]
    [String]
    $DocumentationFolder,
    [Parameter(Mandatory = $true)]
    [ValidateScript({ if (-not (Test-Path -Path $_)) { New-item -ItemType Directory -Path $_ -Force } else { $true } })]
    [String]
    $DestinationFolder
)

# Declare variables
$UrlPrefix = "https://docs.ukcloud.com/articles/"

# Declare empty array
$InfoArray = @()

# Declare to translate product names
$ProductTable = @{
    azs    = "UKCloud for Microsoft Azure"
    cdsz   = "Cross Domain Security Zone"
    conn   = "Connectivity"
    cs     = "Cloud Storage"
    draas  = "Disaster Recovery as a Service"
    email  = "Email and Collaboration"
    enbl   = "Cloud Enablement"
    gpu    = "Cloud GPU"
    hpc    = "High Performance Compute"
    migr   = "Migration to the Cloud"
    orcl   = "UKCloud for Oracle Software"
    oshift = "UKCloud for OpenShift"
    ostack = "UKCloud for OpenStack"
    ptl    = "UKCloud Portal"
    prc    = "Private Cloud for Compute"
    pro    = "Private Cloud for Oracle"
    prs    = "Private Cloud for Storage"
    sra    = "Secure Remote Access"
    sup    = "Support Docs"
    vmw    = "UKCloud for VMware"
    other  = "Other"
}

# Declare to translate type names
$TypeTable = @{
    faq = "FAQs"
    dfx = "DocFX"
    gs  = "Getting Started Guides"
    how = "How To Guides"
    ref = "Reference Guides"
    sco = "Service Scopes"
    vid = "Video"
}

# Get list of all articles
$Articles = Get-ChildItem -Path "$($DocumentationFolder.TrimEnd("\"))\articles" -Recurse -Filter "*.md"

# Create info object for each article
foreach ($Article in $Articles) {
    $Content = Get-Content -Path $Article.FullName
    $ArticleInfo = [PSCustomObject]@{
        Product      = $ProductTable[($Article.Name -split "-")[0]]
        Title        = ($Content | Select-String -Pattern "toc_title") -replace "toc_title: ", ""
        Category     = $TypeTable[((($Article.Name -split "-")[1]).split("."))[0]]
        Link         = $UrlPrefix + ($Article.DirectoryName).split("\")[-1] + "/" + ($Article.Name -replace ".md", ".html")
        LastModified = [String](Get-Date -Date (git -C $DocumentationFolder log -1 --format="%aD" $Article.FullName) -Format "dd/MM/yyyy HH:mm:ss")
        CreationDate = [String](Get-Date -Date (git -C $DocumentationFolder log --follow --format="%aD" -- $Article.FullName | tail -1) -Format "dd/MM/yyyy HH:mm:ss")
        LastReviewed = ($Content | Select-String -Pattern "lastreviewed") -replace "lastreviewed: ", ""
        Reviewer = ($Content | Select-String -Pattern "reviewer") -replace "reviewer: ", ""
    }
    $InfoArray += $ArticleInfo
}

# Export CSV file
$CsvFilePath = $DestinationFolder.TrimEnd("\") + "\" + "KCArticleReport-" + (Get-Date -Format dd-MM-yyyy) + ".csv"
$InfoArray | Sort-Object -Property Product, Category, Title | Export-Csv -Path $CsvFilePath -NoTypeInformation

Write-Output -InputObject "CSV file saved to $CsvFilePath"