diff --git a/dsc/TOC.md b/dsc/TOC.md deleted file mode 100644 index 8c98a6a13541..000000000000 --- a/dsc/TOC.md +++ /dev/null @@ -1,207 +0,0 @@ -# [Overview](overview.md) - -## [Desired State Configuration Overview for Decision Makers](decisionMaker.md) - -## [Desired State Configuration Overview for Engineers](DscForEngineers.md) - -## [DSC quick start](quickStart.md) - -# [Configurations](configurations.md) - -## [Enacting configurations](enactingConfigurations.md) - -## [Separating configuration and environment data](separatingEnvData.md) - -## [Using resources with multiple versions](sxsResource.md) - -## [Running DSC with user credentials](runAsUser.md) - -## [Specifying cross-node dependencies](crossNodeDependencies.md) - -## [Configuration data](configData.md) - -### [Credential options in configuration data](configDataCredentials.md) - -## [Nesting configurations](compositeConfigs.md) - -## [Securing the configuration MOF file](secureMOF.md) - -## [Partial Configurations](partialConfigs.md) - -## [Writing help for DSC configurations](configHelp.md) - -## [Configure a virtual machine at initial boot-up by using DSC](bootstrapDsc.md) - -### [DSCAutomationHostEnabled registry key](DSCAutomationHostEnabled.md) - -# [Resources](resources.md) - -## [Built-in resources](builtInResource.md) - -### [Archive Resource](archiveResource.md) - -### [Environment Resource](environmentResource.md) - -### [File Resource](fileResource.md) - -### [Group Resource](groupResource.md) - -### [GroupSet Resource](groupSetResource.md) - -### [Log Resource](logResource.md) - -### [Package Resource](packageResource.md) - -### [ProcessSet Resource](processSetResource.md) - -### [Registry Resource](registryResource.md) - -### [Script Resource](scriptResource.md) - -### [Service Resource](serviceResource.md) - -### [ServiceSet Resource](serviceSetResource.md) - -### [User Resource](userResource.md) - -### [WaitForAllResource](waitForAllResource.md) - -### [WaitForAnyResource](waitForAnyResource.md) - -### [WaitForSomeResource](waitForSomeResource.md) - -### [WindowsFeature Resource](windowsfeatureResource.md) - -### [WindowsFeatureSet Resource](windowsFeatureSetResource.md) - -### [WindowsOptionalFeature Resource](windowsOptionalFeatureResource.md) - -### [WindowsOptionalFeatureSet Resource](windowsOptionalFeatureSetResource.md) - -### [WindowsPackageCab Resource](windowsPackageCabResource.md) - -### [WindowsProcess Resource](windowsProcessResource.md) - -## [Authoring custom resources](authoringResource.md) - -### [MOF-based custom resources](authoringResourceMOF.md) - -#### [MOF-based resource in C#](authoringResourceMofCS.md) - -### [Class-based custom resouces](authoringResourceClass.md) - -### [Composite resources](authoringResourceComposite.md) - -### [Writing a single-instance DSC resource (best practice)](singleInstance.md) - -### [Resource authoring checklist](resourceAuthoringChecklist.md) - -## [Debugging DSC resources](debugResource.md) - -## [Calling DSC resource methods directly](directCallResource.md) - -# Local Configuration Manager - -## [Configuring the Local Configuration Manager (LCM)](metaConfig.md) - -## [Configuring the LCM in PowerShell 4.0](metaConfig4.md) - -# The DSC pull model - -## [DSC Pull Service](pullServer.md) - -## [Setting up a DSC SMB pull server](pullServerSMB.md) - -## [Setting up a pull client](pullClient.md) - -### [Setting up a pull client using configuration names](pullClientConfigNames.md) - -### [Setting up a pull client using configuration ID](pullClientConfigID.md) - -## [Using a DSC report server](reportServer.md) - -## [Pull server best practices](secureServer.md) - -# [DSC examples](dscExamples.md) - -## [Building a CI/CD pipeline with DSC, Pester, and Visual Studio Team Services](dscCiCd.md) - -## [Separating configuration and environment data](separatingEnvData.md) - -# [Troubleshooting DSC](troubleshooting.md) - -# [Using DSC on Nano Server](nanoDsc.md) - -# DSC on Linux - -## [Getting started with DSC for Linux](lnxGettingStarted.md) - -## [Built-in resources for Linux](lnxBuiltInResources.md) - -### [nxArchive Resource](lnxArchiveResource.md) - -### [nxEnvironment Resource](lnxEnvironmentResource.md) - -### [nxFile Resource](lnxFileResource.md) - -### [nxFileLine Resource](lnxFileLineResource.md) - -### [nxGroup Resource](lnxGroupResource.md) - -### [nxPackage Resource](lnxPackageResource.md) - -### [nxService Resource](lnxServiceResource.md) - -### [nxSshAuthorizedKeys Resource](lnxSshAuthorizedKeysResource.md) - -### [nxUser Resource](lnxUserResource.md) - -# [Using DSC on Microsoft Azure](azureDsc.md) - -## [DSC Extension History](azureDscexthistory.md) - -# DSC MOF Reference - -## [MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager.md) - -### [ApplyConfiguration method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-applyconfiguration.md) - -### [DisableDebugConfiguration method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-disabledebugconfiguration.md) - -### [EnableDebugConfiguration method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-enabledebugconfiguration.md) - -### [GetConfiguration method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-getconfiguration.md) - -### [GetConfigurationResultOutput method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-getconfigurationresultoutput.md) - -### [GetConfigurationStatus method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-getconfigurationstatus.md) - -### [GetMetaConfiguration method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-getmetaconfiguration.md) - -### [PerformRequiredConfigurationChecks method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-performrequiredconfigurationchecks.md) - -### [RemoveConfiguration method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-removeconfiguration.md) - -### [ResourceGet method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-resourceget.md) - -### [ResourceSet method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-resourceset.md) - -### [ResourceTest method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-resourcetest.md) - -### [RollBack method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-rollback.md) - -### [SendConfiguration method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-sendconfiguration.md) - -### [SendConfigurationApply method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-sendconfigurationapply.md) - -### [SendConfigurationApplyAsync method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-sendconfigurationapplyasync.md) - -### [SendMetaConfigurationApply method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-sendmetaconfigurationapply.md) - -### [StopConfiguration method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-stopconfiguration.md) - -### [TestConfiguration method of the MSFT_DSCLocalConfigurationManager class](msft-dsclocalconfigurationmanager-testconfiguration.md) - -# More Resources - -## [Whitepapers](whitepapers.md) diff --git a/dsc/TOC.yml b/dsc/TOC.yml new file mode 100644 index 000000000000..63bf81b6710b --- /dev/null +++ b/dsc/TOC.yml @@ -0,0 +1,221 @@ +- name: Overview + href: overview.md + items: + - name: Desired State Configuration Overview for Decision Makers + href: decisionMaker.md + - name: Desired State Configuration Overview for Engineers + href: DscForEngineers.md + - name: DSC quick start + href: quickStart.md +- name: Configurations + href: configurations.md + items: + - name: Enacting configurations + href: enactingConfigurations.md + - name: Separating configuration and environment data + href: separatingEnvData.md + - name: Using resources with multiple versions + href: sxsResource.md + - name: Running DSC with user credentials + href: runAsUser.md + - name: Specifying cross-node dependencies + href: crossNodeDependencies.md + - name: Configuration data + href: configData.md + items: + - name: Credential options in configuration data + href: configDataCredentials.md + - name: Nesting configurations + href: compositeConfigs.md + - name: Securing the configuration MOF file + href: secureMOF.md + - name: Partial Configurations + href: partialConfigs.md + - name: Writing help for DSC configurations + href: configHelp.md + - name: Configure a virtual machine at initial boot-up by using DSC + href: bootstrapDsc.md + items: + - name: DSCAutomationHostEnabled registry key + href: DSCAutomationHostEnabled.md +- name: Resources + href: resources.md + items: + - name: Built-in resources + href: builtInResource.md + items: + - name: Archive Resource + href: archiveResource.md + - name: Environment Resource + href: environmentResource.md + - name: File Resource + href: fileResource.md + - name: Group Resource + href: groupResource.md + - name: GroupSet Resource + href: groupSetResource.md + - name: Log Resource + href: logResource.md + - name: Package Resource + href: packageResource.md + - name: ProcessSet Resource + href: processSetResource.md + - name: Registry Resource + href: registryResource.md + - name: Script Resource + href: scriptResource.md + - name: Service Resource + href: serviceResource.md + - name: ServiceSet Resource + href: serviceSetResource.md + - name: User Resource + href: userResource.md + - name: WaitForAllResource + href: waitForAllResource.md + - name: WaitForAnyResource + href: waitForAnyResource.md + - name: WaitForSomeResource + href: waitForSomeResource.md + - name: WindowsFeature Resource + href: windowsfeatureResource.md + - name: WindowsFeatureSet Resource + href: windowsFeatureSetResource.md + - name: WindowsOptionalFeature Resource + href: windowsOptionalFeatureResource.md + - name: WindowsOptionalFeatureSet Resource + href: windowsOptionalFeatureSetResource.md + - name: WindowsPackageCab Resource + href: windowsPackageCabResource.md + - name: WindowsProcess Resource + href: windowsProcessResource.md + - name: Authoring custom resources + href: authoringResource.md + items: + - name: MOF-based custom resources + href: authoringResourceMOF.md + items: + - name: MOF-based resource in C# + href: authoringResourceMofCS.md + - name: Class-based custom resouces + href: authoringResourceClass.md + - name: Composite resources + href: authoringResourceComposite.md + - name: Writing a single-instance DSC resource (best practice) + href: singleInstance.md + - name: Resource authoring checklist + href: resourceAuthoringChecklist.md + - name: Debugging DSC resources + href: debugResource.md + - name: Calling DSC resource methods directly + href: directCallResource.md +- name: Local Configuration Manager + items: + - name: Configuring the Local Configuration Manager (LCM) + href: metaConfig.md + - name: Configuring the LCM in PowerShell 4.0 + href: metaConfig4.md +- name: The DSC pull model + items: + - name: DSC Pull Service + href: pullServer.md + - name: Setting up a DSC SMB pull server + href: pullServerSMB.md + - name: Setting up a pull client + href: pullClient.md + items: + - name: Setting up a pull client using configuration names + href: pullClientConfigNames.md + - name: Setting up a pull client using configuration ID + href: pullClientConfigID.md + - name: Using a DSC report server + href: reportServer.md + - name: Pull server best practices + href: secureServer.md +- name: DSC examples + href: dscExamples.md + items: + - name: Building a CI/CD pipeline with DSC, Pester, and Visual Studio Team Services + href: dscCiCd.md + - name: Separating configuration and environment data + href: separatingEnvData.md +- name: Troubleshooting DSC + href: troubleshooting.md +- name: Using DSC on Nano Server + href: nanoDsc.md +- name: DSC on Linux + items: + - name: Getting started with DSC for Linux + href: lnxGettingStarted.md + - name: Built-in resources for Linux + href: lnxBuiltInResources.md + items: + - name: nxArchive Resource + href: lnxArchiveResource.md + - name: nxEnvironment Resource + href: lnxEnvironmentResource.md + - name: nxFile Resource + href: lnxFileResource.md + - name: nxFileLine Resource + href: lnxFileLineResource.md + - name: nxGroup Resource + href: lnxGroupResource.md + - name: nxPackage Resource + href: lnxPackageResource.md + - name: nxService Resource + href: lnxServiceResource.md + - name: nxSshAuthorizedKeys Resource + href: lnxSshAuthorizedKeysResource.md + - name: nxUser Resource + href: lnxUserResource.md +- name: Using DSC on Microsoft Azure + href: azureDsc.md + items: + - name: DSC Extension History + href: azureDscexthistory.md +- name: DSC MOF Reference + items: + - name: MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager.md + items: + - name: ApplyConfiguration method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-applyconfiguration.md + - name: DisableDebugConfiguration method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-disabledebugconfiguration.md + - name: EnableDebugConfiguration method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-enabledebugconfiguration.md + - name: GetConfiguration method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-getconfiguration.md + - name: GetConfigurationResultOutput method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-getconfigurationresultoutput.md + - name: GetConfigurationStatus method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-getconfigurationstatus.md + - name: GetMetaConfiguration method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-getmetaconfiguration.md + - name: PerformRequiredConfigurationChecks method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-performrequiredconfigurationchecks.md + - name: RemoveConfiguration method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-removeconfiguration.md + - name: ResourceGet method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-resourceget.md + - name: ResourceSet method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-resourceset.md + - name: ResourceTest method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-resourcetest.md + - name: RollBack method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-rollback.md + - name: SendConfiguration method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-sendconfiguration.md + - name: SendConfigurationApply method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-sendconfigurationapply.md + - name: SendConfigurationApplyAsync method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-sendconfigurationapplyasync.md + - name: SendMetaConfigurationApply method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-sendmetaconfigurationapply.md + - name: StopConfiguration method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-stopconfiguration.md + - name: TestConfiguration method of the MSFT_DSCLocalConfigurationManager class + href: msft-dsclocalconfigurationmanager-testconfiguration.md +- name: More Resources + items: + - name: Whitepapers + href: whitepapers.md diff --git a/gallery/TOC.md b/gallery/TOC.md deleted file mode 100644 index 57ec5223eb1c..000000000000 --- a/gallery/TOC.md +++ /dev/null @@ -1,67 +0,0 @@ -# [Overview](readme.md) -## Gallery -### [Getting started](psgallery/psgallery_gettingstarted.md) -### [Health Status](psgallery/psgallery_status.md) -### [Gallery FAQs](psgallery/psgallery_faqs.md) -### [Gallery Items tab](psgallery/psgallery_items_tab.md) -### [Gallery search syntax](psgallery/psgallery_search_syntax.md) -### [Items with Compatible PSEditions](psgallery/psgallery_pseditions.md) -### [FileList view](psgallery/psgallery_filelist_feature.md) -### [Deploy to Azure Automation](psgallery/psgallery_deploy_to_azure_automation.md) -### [Creating a PowerShellGallery Account](psgallery/psgallery_creating_an_account.md) -### [Creating and publishing items](psgallery/Creating-and-Publishing-an-item.md) -### [Publishing guidelines and best practices](psgallery/psgallery-PublishingGuidelines.md) -### [Item manifest and Gallery UI](psgallery/psgallery_ItemManifestAffectingUI.md) -### [Unlisting items](psgallery/psgallery_unlist_items.md) -### [Deleting items](psgallery/Deleting-Items.md) -### [Managing item owners](psgallery/Managing-Item-Owners.md) -### [Report Abuse](psgallery/psgallery_report_abuse.md) -### [Dispute resolution](psgallery/psgallery_dispute_resolution.md) -### [Contacting item owners](psgallery/psgallery_contacting_item_owners.md) -### [Contacting administrators](psgallery/psgallery_contacting_administrators.md) -### [Providing Feedback via Social Media or Comments](psgallery/psgallery-SocialMediaFeedback.md) -### [Require License Acceptance on Items details](psgallery/psgallery_requires_license_acceptance.md) -### [Require License Acceptance on Deploy to Azure Automation](psgallery/psgallery_deploy_to_azure_automation_requireLicenseAcceptance.md) - -# [PowerShellGet](psget/overview.md) -## [Get PowerShellGet Module](psget/get_psget_module.md) - -## Module -### [Find Modules](psget/module/psget_find-module.md) -### [Find DSC Resources](psget/module/psget_find-dscresource.md) -### [Find Role Capabilities](psget/module/psget_find-rolecapability.md) -### [Find Commands](psget/module/psget_find-command.md) -### [Save](psget/module/psget_save-module.md) -### [Install](psget/module/psget_install-module.md) -### [Update](psget/module/psget_update-module.md) -### [Uninstall](psget/module/psget_uninstall-module.md) -### [Get installed modules](psget/module/psget_get-installedmodule.md) -### [Update module manifest](psget/module/psget_update-modulemanifest.md) -### [Publish](psget/module/psget_publish-module.md) -### [Modules with PSEditions](psget/module/modulewithpseditionsupport.md) -### [Modules Requiring License Acceptance](psget/module/RequireLicenseAcceptance.md) -### [Prerelease Versions](psget/module/PreReleaseModule.md) -### [Troubleshooting](psget/psget_cmdlets_troubleshooting.md) - -## Script -### [Find](psget/script/psget_find-script.md) -### [Save](psget/script/psget_save-script.md) -### [Install](psget/script/psget_install-script.md) -### [Update](psget/script/psget_update-script.md) -### [Uninstall](psget/script/psget_uninstall-script.md) -### [Get installed scipts](psget/script/psget_get-installedscript.md) -### [Create script file with metadata](psget/script/psget_new-scriptfileinfo.md) -### [Test script file metadata](psget/script/psget_test-scriptfileinfo.md) -### [Update script file metadata](psget/script/psget_update-scriptfileinfo.md) -### [Publish](psget/script/psget_publish-script.md) -### [Scripts with PSEditions](psget/script/scriptwithpseditionsupport.md) -### [Require License Acceptance for Scripts](psget/script/script_RequireLicenseAcceptance.md) -### [Prerelease Versions](psget/script/PreReleaseScript.md) -## Repository management -### [Bootstrapping NuGet provider and NuGet.exe](psget/repository/bootstrapping_nuget_proivder_and_exe.md) -### [Registering repository](psget/repository/psget_register-psrepository.md) -### [Listing registered repository](psget/repository/psget_get-psrepository.md) -### [Modifying registered repository](psget/repository/psget_set-psrepository.md) -### [Unregistering repository](psget/repository/psget_unregister-psrepository.md) - -## [PackageManagement cmdlets](psget/oneget/PackageManagement_cmdlets.md) diff --git a/gallery/TOC.yml b/gallery/TOC.yml new file mode 100644 index 000000000000..cd9234e172e7 --- /dev/null +++ b/gallery/TOC.yml @@ -0,0 +1,128 @@ +- name: Overview + href: readme.md + items: + - name: Gallery + items: + - name: Getting started + href: psgallery/psgallery_gettingstarted.md + - name: Health Status + href: psgallery/psgallery_status.md + - name: Gallery FAQs + href: psgallery/psgallery_faqs.md + - name: Gallery Items tab + href: psgallery/psgallery_items_tab.md + - name: Gallery search syntax + href: psgallery/psgallery_search_syntax.md + - name: Items with Compatible PSEditions + href: psgallery/psgallery_pseditions.md + - name: FileList view + href: psgallery/psgallery_filelist_feature.md + - name: Deploy to Azure Automation + href: psgallery/psgallery_deploy_to_azure_automation.md + - name: Creating a PowerShellGallery Account + href: psgallery/psgallery_creating_an_account.md + - name: Creating and publishing items + href: psgallery/Creating-and-Publishing-an-item.md + - name: Publishing guidelines and best practices + href: psgallery/psgallery-PublishingGuidelines.md + - name: Item manifest and Gallery UI + href: psgallery/psgallery_ItemManifestAffectingUI.md + - name: Unlisting items + href: psgallery/psgallery_unlist_items.md + - name: Deleting items + href: psgallery/Deleting-Items.md + - name: Managing item owners + href: psgallery/Managing-Item-Owners.md + - name: Report Abuse + href: psgallery/psgallery_report_abuse.md + - name: Dispute resolution + href: psgallery/psgallery_dispute_resolution.md + - name: Contacting item owners + href: psgallery/psgallery_contacting_item_owners.md + - name: Contacting administrators + href: psgallery/psgallery_contacting_administrators.md + - name: Providing Feedback via Social Media or Comments + href: psgallery/psgallery-SocialMediaFeedback.md + - name: Require License Acceptance on Items details + href: psgallery/psgallery_requires_license_acceptance.md + - name: Require License Acceptance on Deploy to Azure Automation + href: psgallery/psgallery_deploy_to_azure_automation_requireLicenseAcceptance.md +- name: PowerShellGet + href: psget/overview.md + items: + - name: Get PowerShellGet Module + href: psget/get_psget_module.md + - name: Module + items: + - name: Find Modules + href: psget/module/psget_find-module.md + - name: Find DSC Resources + href: psget/module/psget_find-dscresource.md + - name: Find Role Capabilities + href: psget/module/psget_find-rolecapability.md + - name: Find Commands + href: psget/module/psget_find-command.md + - name: Save + href: psget/module/psget_save-module.md + - name: Install + href: psget/module/psget_install-module.md + - name: Update + href: psget/module/psget_update-module.md + - name: Uninstall + href: psget/module/psget_uninstall-module.md + - name: Get installed modules + href: psget/module/psget_get-installedmodule.md + - name: Update module manifest + href: psget/module/psget_update-modulemanifest.md + - name: Publish + href: psget/module/psget_publish-module.md + - name: Modules with PSEditions + href: psget/module/modulewithpseditionsupport.md + - name: Modules Requiring License Acceptance + href: psget/module/RequireLicenseAcceptance.md + - name: Prerelease Versions + href: psget/module/PreReleaseModule.md + - name: Troubleshooting + href: psget/psget_cmdlets_troubleshooting.md + - name: Script + items: + - name: Find + href: psget/script/psget_find-script.md + - name: Save + href: psget/script/psget_save-script.md + - name: Install + href: psget/script/psget_install-script.md + - name: Update + href: psget/script/psget_update-script.md + - name: Uninstall + href: psget/script/psget_uninstall-script.md + - name: Get installed scipts + href: psget/script/psget_get-installedscript.md + - name: Create script file with metadata + href: psget/script/psget_new-scriptfileinfo.md + - name: Test script file metadata + href: psget/script/psget_test-scriptfileinfo.md + - name: Update script file metadata + href: psget/script/psget_update-scriptfileinfo.md + - name: Publish + href: psget/script/psget_publish-script.md + - name: Scripts with PSEditions + href: psget/script/scriptwithpseditionsupport.md + - name: Require License Acceptance for Scripts + href: psget/script/script_RequireLicenseAcceptance.md + - name: Prerelease Versions + href: psget/script/PreReleaseScript.md + - name: Repository management + items: + - name: Bootstrapping NuGet provider and NuGet.exe + href: psget/repository/bootstrapping_nuget_proivder_and_exe.md + - name: Registering repository + href: psget/repository/psget_register-psrepository.md + - name: Listing registered repository + href: psget/repository/psget_get-psrepository.md + - name: Modifying registered repository + href: psget/repository/psget_set-psrepository.md + - name: Unregistering repository + href: psget/repository/psget_unregister-psrepository.md + - name: PackageManagement cmdlets + href: psget/oneget/PackageManagement_cmdlets.md diff --git a/gallery/docfx.json b/gallery/docfx.json index 7015d17719f4..af03c10b1955 100644 --- a/gallery/docfx.json +++ b/gallery/docfx.json @@ -10,7 +10,7 @@ } ], "globalMetadata": { - "breadcrumb_path": "/powershell/gallery/bread/toc.json", + "breadcrumb_path": "/powershell/gallery/bread/toc.yml", "ROBOTS": "INDEX, FOLLOW", "uhfHeaderId": "MSDocsHeader-Powershell", "ms.prod": "powershell", diff --git a/jea/TOC.MD b/jea/TOC.MD deleted file mode 100644 index 2af6fcc53fec..000000000000 --- a/jea/TOC.MD +++ /dev/null @@ -1,11 +0,0 @@ - -# [Overview](overview.md) - -# Deploy JEA -## [Prerequisites](prerequisites.md) -## [Role Capabilities](role-capabilities.md) -## [Session Configurations](session-configurations.md) -## [Registering JEA](register-jea.md) -## [Using JEA](using-jea.md) -## [Security Considerations](security-considerations.md) -## [Audit and Report on JEA](audit-and-report.md) diff --git a/jea/TOC.yml b/jea/TOC.yml new file mode 100644 index 000000000000..58213d9786a5 --- /dev/null +++ b/jea/TOC.yml @@ -0,0 +1,18 @@ +- name: Overview + href: overview.md +- name: Deploy JEA + items: + - name: Prerequisites + href: prerequisites.md + - name: Role Capabilities + href: role-capabilities.md + - name: Session Configurations + href: session-configurations.md + - name: Registering JEA + href: register-jea.md + - name: Using JEA + href: using-jea.md + - name: Security Considerations + href: security-considerations.md + - name: Audit and Report on JEA + href: audit-and-report.md diff --git a/jea/docfx.json b/jea/docfx.json index 431b86b21360..653e62d53740 100644 --- a/jea/docfx.json +++ b/jea/docfx.json @@ -10,7 +10,7 @@ } ], "globalMetadata": { - "breadcrumb_path": "bread/toc.json", + "breadcrumb_path": "bread/toc.yml", "uhfHeaderId": "MSDocsHeader-Powershell", "ROBOTS": "INDEX, FOLLOW", "ms.prod": "powershell", diff --git a/reference/docfx.json b/reference/docfx.json index ffb21c5245ab..5b366ceaf4b9 100644 --- a/reference/docfx.json +++ b/reference/docfx.json @@ -49,7 +49,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { - "breadcrumb_path": "/powershell/bread-pscore/toc.json", + "breadcrumb_path": "/powershell/bread-pscore/toc.yml", "uhfHeaderId": "MSDocsHeader-Powershell", "apiPlatform": "powershell", "ms.devlang": "powershell", diff --git a/wmf/TOC.md b/wmf/TOC.md deleted file mode 100644 index 82501f4ce8ea..000000000000 --- a/wmf/TOC.md +++ /dev/null @@ -1,97 +0,0 @@ -# [Windows Management Framework (WMF) Overview](README.md) - -# [WMF 5.1](5.1/release-notes.md) -## [New Scenarios and Features](5.1/scenarios-features.md) -### [Improvements in Desired State Configuration (DSC)](5.1/DSC-improvements.md) -### [Improvements in the PowerShell Console](5.1/console-improvements.md) -### [Improvements in the PowerShell Engine](5.1/engine-improvements.md) -### [Improvements in Package Management](5.1/package-management-improvements.md) -### [Improvements in JEA](5.1/jea-improvements.md) -### [Catalog cmdlets](5.1/catalog-cmdlets.md) -### [Bugs Fixed in WMF 5.1](5.1/bugfixes.md) -## [Install and Configure](5.1/install-configure.md) -## [Known Issues](5.1/known-issues.md) -## [Compatibility](5.1/Compatibility.md) -## [Product Compatibility](5.1/productincompat.md) - -# [WMF 5.0](5.0/releasenotes.md) -## [Installation Details](5.0/requirements.md) -## [Known Issues and Limitations](5.0/limitation_overview.md) -### [Desired State Configuration (DSC) Known Issues](5.0/limitation_dsc.md) -## [Product Compatibility Status](5.0/productincompat.md) -## [Scenarios Enabled by WMF 5.0]() -### [Just Enough Administration (JEA)](5.0/jea_overview.md) -#### [Creating and Connecting to a JEA Endpoint](5.0/jea_endpoint.md) -#### [Reporting on JEA](5.0/jea_report.md) -### [Creating Custom Types using PowerShell Classes](5.0/class_overview.md) -#### [Define Custom Types](5.0/class_newtype.md) -#### [Declare Base Class](5.0/class_base.md) -#### [Declare Implemented Interface](5.0/class_interface.md) -#### [Call Base Class Constructor](5.0/class_baseconstructor.md) -#### [Call Base Class Method](5.0/class_basemethod.md) -### [Improvements in PowerShell Script Debugging](5.0/debug_overview.md) -### [Improvements in Desired State Configuration (DSC)](5.0/dsc_improvements.md) -#### [Configurations]() -##### [Specifying Cross Node Dependencies](5.0/dsc_waitfor.md) -##### [Encrypted MOFs](5.0/dsc_encryptedmof.md) -##### [Help Support for DSC Configuration](5.0/dsc_confighelp.md) -##### [Authoring Improvements using PowerShell ISE](5.0/dsc_authoring.md) -##### [Allowance for Identical Duplicate Resources in a Configuration](5.0/dsc_identicalduplicate.md) -##### [Import-DscResource Keyword Supports -ModuleVersion Parameter](5.0/dsc_importdscresource.md) -##### [WOW64 Support for Configuration Keyword](5.0/dsc_wow64.md) -#### [Resources]() -##### [Class-based DSC Resources](5.0/dsc_classbasedresource.md) -##### [DSC Resource Script Debugging](5.0/dsc_resourcedebugging.md) -##### [Automatic RunAs Support for DSC Resources](5.0/dsc_runas.md) -##### [Side-By-Side Versioning Support for DSC Resources](5.0/dsc_sxsresource.md) -##### [New In-box Resources](5.0/dsc_newresources.md) -#### [Local Configuration Manager]() -##### [Configure Node with Multiple Configuration Fragments](5.0/dsc_partialconfig.md) -###### [Support for Mixed RefreshModes](5.0/dsc_partialconfig_mixedmode.md) -##### [Configure DSC Engine with New Attribute](5.0/dsc_metaconfiguration.md) -##### [Detailed Information about LCM State](5.0/dsc_lcmstate.md) -##### [Frequencies for RefreshMode and ConfigurationMode need not be Multiple of Each Other](5.0/dsc_freqnomultiple.md) -##### [Additional Value for RefreshMode Property](5.0/dsc_refreshmode.md) -#### [Cmdlets]() -##### [Details about Configuration Status](5.0/dsc_getconfigurationstatus.md) -##### [Test-DscConfiguration Cmdlet Supports Reference Configurations](5.0/dsc_testconfiguration.md) -##### [Direct Access to DSC Resource Methods](5.0/dsc_directaccess.md) -##### [Deliver Configuration Document without Applying](5.0/dsc_publishconfig.md) -##### [Remove DSC Documents](5.0/dsc_removeconfigdoc.md) -##### [Unified and Consistent State and Status Representation](5.0/dsc_statestatus.md) -##### [Set-DscLocalConfigurationManager Cmdlet Supports -Force Parameter](5.0/dsc_setdsclcm.md) -#### [Pull Mode]() -##### [On-demand PULL of DSC Configurations](5.0/dsc_updateconfig.md) -##### [Separation of Node and Configuration IDs](5.0/dsc_nodeid.md) -##### [Separation of Configuration, Resource, and Report Repositories](5.0/dsc_repository.md) -##### [Report Configuration Status to Central Location](5.0/dsc_reporting.md) -### [Audit PowerShell Usage using Transcript and Logging](5.0/audit_overview.md) -#### [Enhanced Transcription Options](5.0/audit_transcript.md) -#### [Script Tracing and Logging](5.0/audit_script.md) -#### [Cryptographic Message Syntax (CMS) Cmdlets](5.0/audit_cms.md) -### [Software Discovery, Install, and Inventory with PackageManagement](5.0/oneget_overview.md) -#### [PackageManagement Cmdlets](5.0/oneget_cmdlets.md) -### [PowerShell Module Discovery, Install, and Inventory with PowerShellGet](5.0/psget_module_overview.md) -#### [Register a PowerShell Repository](5.0/psget_psrepository.md) -#### [Side-by-Side Version Support on PowerShell 5.0 or Newer](5.0/psget_modulesxsinstall.md) -#### [Installation of Module Dependencies](5.0/psget_moduledependency.md) -#### [PowerShellGet Cmdlets for Module Management](5.0/psget_modulecmdlets.md) -### [PowerShell Script Discovery, Install, and Management with PowerShellGet](5.0/psget_script_overview.md) -#### [PowerShellGet Cmdlets for Script Management](5.0/psget_scriptcmdlets.md) -### [New and Updated Cmdlets based on Community Feedback](5.0/feedback_cmdlets.md) -#### [Symbolic Links using Item Cmdlets](5.0/feedback_symbolic.md) -#### [Archive Cmdlets](5.0/feedback_archive.md) -#### [Clipboard Cmdlets](5.0/feedback_clipboard.md) -#### [Convert-String](5.0/feedback_convertstring.md) -#### [Extract and Parse Structured Objects out of String](5.0/feedback_convertfromString.md) -#### [Format-Hex](5.0/feedback_formathex.md) -#### [NoNewLine Parameter](5.0/feedback_nonewline.md) -#### [New-TemporaryFile](5.0/feedback_tempfile.md) -#### [New-Guid](5.0/feedback_newguid.md) -#### [Get-ChildItem has -Depth Parameter](5.0/feedback_getchilditem.md) -#### [Updates to FileInfo object](5.0/feedback_fileinfo.md) -#### [Modules Support for Declaring Version Ranges (1.*, etc)](5.0/feedback_moduleversionranges.md) -### [Information Stream](5.0/informationstream_overview.md) -### [Generate PowerShell Cmdlets based on OData Endpoint](5.0/odata_overview.md) -### [Network Switch Management with PowerShell](5.0/networkswitch_overview.md) -### [Software Inventory Logging (SIL)](5.0/sil_overview.md) diff --git a/wmf/TOC.yml b/wmf/TOC.yml new file mode 100644 index 000000000000..1f2bdbad2282 --- /dev/null +++ b/wmf/TOC.yml @@ -0,0 +1,209 @@ +- name: Windows Management Framework (WMF) Overview + href: README.md +- name: WMF 5.1 + href: 5.1/release-notes.md + items: + - name: New Scenarios and Features + href: 5.1/scenarios-features.md + items: + - name: Improvements in Desired State Configuration (DSC) + href: 5.1/DSC-improvements.md + - name: Improvements in the PowerShell Console + href: 5.1/console-improvements.md + - name: Improvements in the PowerShell Engine + href: 5.1/engine-improvements.md + - name: Improvements in Package Management + href: 5.1/package-management-improvements.md + - name: Improvements in JEA + href: 5.1/jea-improvements.md + - name: Catalog cmdlets + href: 5.1/catalog-cmdlets.md + - name: Bugs Fixed in WMF 5.1 + href: 5.1/bugfixes.md + - name: Install and Configure + href: 5.1/install-configure.md + - name: Known Issues + href: 5.1/known-issues.md + - name: Compatibility + href: 5.1/Compatibility.md + - name: Product Compatibility + href: 5.1/productincompat.md +- name: WMF 5.0 + href: 5.0/releasenotes.md + items: + - name: Installation Details + href: 5.0/requirements.md + - name: Known Issues and Limitations + href: 5.0/limitation_overview.md + items: + - name: Desired State Configuration (DSC) Known Issues + href: 5.0/limitation_dsc.md + - name: Product Compatibility Status + href: 5.0/productincompat.md + - name: Scenarios Enabled by WMF 5.0 + href: '' + items: + - name: Just Enough Administration (JEA) + href: 5.0/jea_overview.md + items: + - name: Creating and Connecting to a JEA Endpoint + href: 5.0/jea_endpoint.md + - name: Reporting on JEA + href: 5.0/jea_report.md + - name: Creating Custom Types using PowerShell Classes + href: 5.0/class_overview.md + items: + - name: Define Custom Types + href: 5.0/class_newtype.md + - name: Declare Base Class + href: 5.0/class_base.md + - name: Declare Implemented Interface + href: 5.0/class_interface.md + - name: Call Base Class Constructor + href: 5.0/class_baseconstructor.md + - name: Call Base Class Method + href: 5.0/class_basemethod.md + - name: Improvements in PowerShell Script Debugging + href: 5.0/debug_overview.md + - name: Improvements in Desired State Configuration (DSC) + href: 5.0/dsc_improvements.md + items: + - name: Configurations + href: '' + items: + - name: Specifying Cross Node Dependencies + href: 5.0/dsc_waitfor.md + - name: Encrypted MOFs + href: 5.0/dsc_encryptedmof.md + - name: Help Support for DSC Configuration + href: 5.0/dsc_confighelp.md + - name: Authoring Improvements using PowerShell ISE + href: 5.0/dsc_authoring.md + - name: Allowance for Identical Duplicate Resources in a Configuration + href: 5.0/dsc_identicalduplicate.md + - name: Import-DscResource Keyword Supports -ModuleVersion Parameter + href: 5.0/dsc_importdscresource.md + - name: WOW64 Support for Configuration Keyword + href: 5.0/dsc_wow64.md + - name: Resources + href: '' + items: + - name: Class-based DSC Resources + href: 5.0/dsc_classbasedresource.md + - name: DSC Resource Script Debugging + href: 5.0/dsc_resourcedebugging.md + - name: Automatic RunAs Support for DSC Resources + href: 5.0/dsc_runas.md + - name: Side-By-Side Versioning Support for DSC Resources + href: 5.0/dsc_sxsresource.md + - name: New In-box Resources + href: 5.0/dsc_newresources.md + - name: Local Configuration Manager + href: '' + items: + - name: Configure Node with Multiple Configuration Fragments + href: 5.0/dsc_partialconfig.md + items: + - name: Support for Mixed RefreshModes + href: 5.0/dsc_partialconfig_mixedmode.md + - name: Configure DSC Engine with New Attribute + href: 5.0/dsc_metaconfiguration.md + - name: Detailed Information about LCM State + href: 5.0/dsc_lcmstate.md + - name: Frequencies for RefreshMode and ConfigurationMode need not be Multiple of Each Other + href: 5.0/dsc_freqnomultiple.md + - name: Additional Value for RefreshMode Property + href: 5.0/dsc_refreshmode.md + - name: Cmdlets + href: '' + items: + - name: Details about Configuration Status + href: 5.0/dsc_getconfigurationstatus.md + - name: Test-DscConfiguration Cmdlet Supports Reference Configurations + href: 5.0/dsc_testconfiguration.md + - name: Direct Access to DSC Resource Methods + href: 5.0/dsc_directaccess.md + - name: Deliver Configuration Document without Applying + href: 5.0/dsc_publishconfig.md + - name: Remove DSC Documents + href: 5.0/dsc_removeconfigdoc.md + - name: Unified and Consistent State and Status Representation + href: 5.0/dsc_statestatus.md + - name: Set-DscLocalConfigurationManager Cmdlet Supports -Force Parameter + href: 5.0/dsc_setdsclcm.md + - name: Pull Mode + href: '' + items: + - name: On-demand PULL of DSC Configurations + href: 5.0/dsc_updateconfig.md + - name: Separation of Node and Configuration IDs + href: 5.0/dsc_nodeid.md + - name: Separation of Configuration, Resource, and Report Repositories + href: 5.0/dsc_repository.md + - name: Report Configuration Status to Central Location + href: 5.0/dsc_reporting.md + - name: Audit PowerShell Usage using Transcript and Logging + href: 5.0/audit_overview.md + items: + - name: Enhanced Transcription Options + href: 5.0/audit_transcript.md + - name: Script Tracing and Logging + href: 5.0/audit_script.md + - name: Cryptographic Message Syntax (CMS) Cmdlets + href: 5.0/audit_cms.md + - name: Software Discovery, Install, and Inventory with PackageManagement + href: 5.0/oneget_overview.md + items: + - name: PackageManagement Cmdlets + href: 5.0/oneget_cmdlets.md + - name: PowerShell Module Discovery, Install, and Inventory with PowerShellGet + href: 5.0/psget_module_overview.md + items: + - name: Register a PowerShell Repository + href: 5.0/psget_psrepository.md + - name: Side-by-Side Version Support on PowerShell 5.0 or Newer + href: 5.0/psget_modulesxsinstall.md + - name: Installation of Module Dependencies + href: 5.0/psget_moduledependency.md + - name: PowerShellGet Cmdlets for Module Management + href: 5.0/psget_modulecmdlets.md + - name: PowerShell Script Discovery, Install, and Management with PowerShellGet + href: 5.0/psget_script_overview.md + items: + - name: PowerShellGet Cmdlets for Script Management + href: 5.0/psget_scriptcmdlets.md + - name: New and Updated Cmdlets based on Community Feedback + href: 5.0/feedback_cmdlets.md + items: + - name: Symbolic Links using Item Cmdlets + href: 5.0/feedback_symbolic.md + - name: Archive Cmdlets + href: 5.0/feedback_archive.md + - name: Clipboard Cmdlets + href: 5.0/feedback_clipboard.md + - name: Convert-String + href: 5.0/feedback_convertstring.md + - name: Extract and Parse Structured Objects out of String + href: 5.0/feedback_convertfromString.md + - name: Format-Hex + href: 5.0/feedback_formathex.md + - name: NoNewLine Parameter + href: 5.0/feedback_nonewline.md + - name: New-TemporaryFile + href: 5.0/feedback_tempfile.md + - name: New-Guid + href: 5.0/feedback_newguid.md + - name: Get-ChildItem has -Depth Parameter + href: 5.0/feedback_getchilditem.md + - name: Updates to FileInfo object + href: 5.0/feedback_fileinfo.md + - name: Modules Support for Declaring Version Ranges (1.*, etc) + href: 5.0/feedback_moduleversionranges.md + - name: Information Stream + href: 5.0/informationstream_overview.md + - name: Generate PowerShell Cmdlets based on OData Endpoint + href: 5.0/odata_overview.md + - name: Network Switch Management with PowerShell + href: 5.0/networkswitch_overview.md + - name: Software Inventory Logging (SIL) + href: 5.0/sil_overview.md diff --git a/wmf/docfx.json b/wmf/docfx.json index baf309eb2474..9b954f0507d8 100644 --- a/wmf/docfx.json +++ b/wmf/docfx.json @@ -10,7 +10,7 @@ } ], "globalMetadata": { - "breadcrumb_path": "/powershell/wmf/bread/toc.json", + "breadcrumb_path": "/powershell/wmf/bread/toc.yml", "uhfHeaderId": "MSDocsHeader-Powershell", "ROBOTS": "INDEX, FOLLOW", "ms.prod": "powershell",