﻿TOPIC
    about_netappdocs

SHORT DESCRIPTION
    Contains a set of functions that automates NetApp site design documentation.

LONG DESCRIPTION
    NetAppDocs provides a set of functions that automates NetApp site design
    documentation. It can output both Microsoft Word and Microsoft Excel files.
    The data contained in the output files can be sanitized for use in sites
    where the data may be sensitive.

System Requirements
    - Windows:   - Windows PowerShell 5.1+ and PowerShell 7.0.3+.   - Microsoft
    .NET Framework 4.6.2+. - MAC/Linux:   - PowerShell 7.0.3+ and 7.1+ (7.2+
    support coming soon).   - libgdiplus and libc6-dev packages. - ONTAP:
    NetApp.ONTAP PowerShell module (included in the install package).
    - Internal NetApp connection and SSO login required for ASUP data
    collection.

PowerShell Execution Policy (Windows-Only)
    The PowerShell execution policy must be set to anything other than the
    default setting of 'Restricted', as this setting does not allow scripts to
    run. The files within this module are digitally signed and will run whether
    the policy is set to 'Unrestricted', 'RemoteSigned' or 'AllSigned'. To do
    this, right click on PowerShell and select 'Run as Administrator'. Then run
    the following command:

    PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

Install Guide
    The installation scripts contained within the ZIP file are the preferred
    method for installing this module on all platforms. This uses native
    PowerShell commands to install the module to the appropriate user location
    and does not require administrative rights. You can also copy the module
    folder manually using this same ZIP file.
    Please see the NetAppDocs User Guide for additional installation
    information.

    WINDOWS
    If a previous version of the module was installed via the Windows Installer
    (MSI) package, it is recommended to remove all previous versions using the
    'Apps & features' or the 'Add or remove programs' application in the System
    Settings area.
    To install the module, unzip the contents of the ZIP file to a temp folder
    and run the .BAT script to automate the installation.

    MAC/LINUX
    MAC and Linux clients require the installation of Microsoft PowerShell. The
    following dependency packages must also be installed (using the OS
    appropriate package installation tool):
    - MAC   - mono-libgdiplus - Linux   - libgdiplus   - libc6-dev
    Once these prerequisites are installed, unzip the contents of the ZIP file
    to a temp folder and run the .SH script to automate the instalation.

Uninstall Guide
    If the installation script within the ZIP file was used, you can use the
    Uninstall-Module cmdlet to remove the module. If the Windows Installer
    package was used, you must remove the module using the 'Apps & features' or
    the 'Add or remove programs' application in the System Settings area. If the
    ZIP file was used to manually copy the files, you can manually delete the
    folder.

Additional Information
    Usage examples and other additional information can be found in the webhelp
    folder of the module, or by typing 'Show-NtapDocsHelp' within PowerShell
    after importing the module. The NetAppDocs User Guide is also available on
    the
    NetApp Tools Download Site
    .

