Skip to content

Commit

Permalink
Merge pull request #3456 from KoenZomers/FixingDocumentationBuildWarn…
Browse files Browse the repository at this point in the history
…ings

Fixing documentation build warnings
  • Loading branch information
KoenZomers authored Oct 1, 2023
2 parents b3d1110 + f638a59 commit 5462b6d
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 8 deletions.
2 changes: 1 addition & 1 deletion documentation/Disconnect-PnPOnline.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Disconnect-PnPOnline

## DESCRIPTION

Disconnects the current connection and clears its token cache. It will require you to build up a new connection again using [Connect-PnPOnline](Connect-PnPOnline.html) in order to use any of the PnP PowerShell cmdlets. You will have to reauthenticate. If instead you simply want to connect to another site collection within the same tenant using the same credentials you used previously, do not use this cmdlet but instead use `Connect-PnPOnline -Url https://tenant.sharepoint.com/sites/othersite` instead without disconnecting. It will try to reuse the existing authentication method and cached credentials.
Disconnects the current connection and clears its token cache. It will require you to build up a new connection again using [Connect-PnPOnline](Connect-PnPOnline.md) in order to use any of the PnP PowerShell cmdlets. You will have to reauthenticate. If instead you simply want to connect to another site collection within the same tenant using the same credentials you used previously, do not use this cmdlet but instead use `Connect-PnPOnline -Url https://tenant.sharepoint.com/sites/othersite` instead without disconnecting. It will try to reuse the existing authentication method and cached credentials.

Note that this cmdlet does not support passing in a specific connection to disconnect. If you wish to dispose a specific connection you have set up in a variable using `$variable = Connect-PnPOnline -ReturnConnection`, just dispose that variable using `$variable = $null` and it will be cleared from memory.

Expand Down
2 changes: 0 additions & 2 deletions pages/articles/azureautomationrunbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,6 @@ To add PnP PowerShell to the Azure Automation Account, follow these steps:

Click on **Import** to start the download and importing process.

![Start importing the PnP PowerShell module](../images/azureautomation/automationaddmodulepnpposhcustombuildimport.png)

It will take up to 10 minutes for the import to complete. You can check the import status by changing the **Module type** filter to **Custom**.

![Check the import status](../images/azureautomation/automationaddmodulepnpposhcustombuildstatus.png)
Expand Down
6 changes: 3 additions & 3 deletions pages/articles/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

By default PnP PowerShell will report its usage anonymously to the PnP team. We collection information about the **version of PnP PowerShell**, the **operation system version** and the **cmdlet** executed. Notice that we will *not* include parameters used and we will *not* include any values of parameters. We will also *not* be able to trace the execution back to the specific tenant it ran on, the organization it was used for or the person it was run by. Having telemtry in place allows us to get insight in the usage of cmdlets and thereby prioritize work towards the most popular cmdlets.

To query if in a connected PnP PowerShell session the telemetry is enabled, use [Get-PnPPowerShellTelemetryEnabled](../cmdlets/Get-PnPPowerShellTelemetryEnabled.html).
To query if in a connected PnP PowerShell session the telemetry is enabled, use [Get-PnPPowerShellTelemetryEnabled](../cmdlets/Get-PnPPowerShellTelemetryEnabled.md).

If you wish to control telemetry to be sent, you can use one of the below options.

## By using PnP PowerShell
You can disable telemetry to be sent by using [Disable-PnPPowerShellTelemetry](../cmdlets/Disable-PnPPowerShellTelemetry.html).
You can enable telemetry to be sent by using [Enable-PnPPowerShellTelemetry](../cmdlets/Enable-PnPPowerShellTelemetry.html).
You can disable telemetry to be sent by using [Disable-PnPPowerShellTelemetry](../cmdlets/Disable-PnPPowerShellTelemetry.md).
You can enable telemetry to be sent by using [Enable-PnPPowerShellTelemetry](../cmdlets/Enable-PnPPowerShellTelemetry.md).

## By setting an environment variable
To disable telemetry, set the `PNPPOWERSHELL_DISABLETELEMETRY` environment variable to `true`, i.e. by using `$env:PNPPOWERSHELL_DISABLETELEMETRY=$true`. Remove the entry again or set it to `false` to enable telemetry to be sent again.
Expand Down
2 changes: 0 additions & 2 deletions pages/articles/updatenotifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ If you have a script and want to turn off the update check, simply set the follo
$env:PNPPOWERSHELL_UPDATECHECK="false"
```

See [Configure PnP PowerShell](configuration.md) for more information on the environment variables you can set.

## When do you receive an update notification

If the major version of your current version is lower than the currently available major version.
Expand Down
1 change: 1 addition & 0 deletions powershell
Submodule powershell added at a7a08d

0 comments on commit 5462b6d

Please sign in to comment.