Skip to content

Commit

Permalink
nest screenshots under windows folder, tweak wording to be more profe…
Browse files Browse the repository at this point in the history
…ssional.
  • Loading branch information
BinaryFissionGames committed Mar 7, 2022
1 parent 990afd4 commit eabd9f8
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions docs/installation-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To install the collector on Windows, first [download the latest MSI](https://git

After downloading the MSI, simply double click it to open the installation wizard. Follow the instructions to configure and install the collector.

Alternatively, you can run the Powershell command below to install the MSI with no UI.
Alternatively, the Powershell command below may be run to install the MSI with no UI.
```pwsh
msiexec /i "<path-to-msi>" /quiet
```
Expand All @@ -17,19 +17,19 @@ After installing, the `observiq-collector` service will be running and ready for

Logs from the collector will appear in the Application event log.

By default, the config file for the collector can be found at `C:\Program Files\observiq-collector\config.yaml`. When changing the configuration, you must restart the collector in order for config changes to take effect.
By default, the config file for the collector can be found at `C:\Program Files\observiq-collector\config.yaml`. When changing the configuration,the collector service must be restarted in order for config changes to take effect.

## Restarting the Collector
Restarting the collector may be done through the services dialog.
To access the services dialog, press Win + R, enter `services.msc` into the Run dialog, and press enter.

![The run dialog](./screenshots/launch-services.png)
![The run dialog](./screenshots/windows/launch-services.png)

Locate the `observiq-collector` service, right click the entry, and click "Restart" to restart the collector.

![The services dialog](./screenshots/stop-restart-service.png)
![The services dialog](./screenshots/windows/stop-restart-service.png)

Alternatively, you may run the Powershell command below.
Alternatively, the Powershell command below may be run to restart the collector service.
```pwsh
Restart-Service -Name "observiq-collector"
```
Expand All @@ -39,13 +39,13 @@ Restart-Service -Name "observiq-collector"
Stopping the collector may be done through the services dialog.
To access the services dialog, press Win + R, enter `services.msc` into the Run dialog, and press enter.

![The run dialog](./screenshots/launch-services.png)
![The run dialog](./screenshots/windows/launch-services.png)

Locate the `observiq-collector` service, right click the entry, and click "Stop" to stop the collector.

![The services dialog](./screenshots/stop-restart-service.png)
![The services dialog](./screenshots/windows/stop-restart-service.png)

Alternatively, you may run the Powershell command below.
Alternatively, the Powershell command below may be run to stop the collector service.
```pwsh
Stop-Service -Name "observiq-collector"
```
Expand All @@ -55,13 +55,13 @@ Stop-Service -Name "observiq-collector"
Starting the collector may be done through the services dialog.
To access the services dialog, press Win + R, enter `services.msc` into the Run dialog, and press enter.

![The run dialog](./screenshots/launch-services.png)
![The run dialog](./screenshots/windows/launch-services.png)

Locate the `observiq-collector` service, right click the entry, and click "Start" to start the collector.

![The services dialog](./screenshots/start-service.png)
![The services dialog](./screenshots/windows/start-service.png)

Alternatively, you may run the Powershell command below.
Alternatively, the Powershell command below may be run to start the collector service.
```pwsh
Start-Service -Name "observiq-collector"
```
Expand All @@ -70,15 +70,15 @@ Start-Service -Name "observiq-collector"

To uninstall the collector on Windows, navigate to the control panel, then to the "Uninstall a program" dialog.

![The control panel](./screenshots/control-panel-uninstall.png)
![The control panel](./screenshots/windows/control-panel-uninstall.png)

Locate the `observiq-collector` entry, and select uninstall.

![The uninstall or change a program dialog](./screenshots/uninstall-collector.png)
![The uninstall or change a program dialog](./screenshots/windows/uninstall-collector.png)

Follow the wizard to complete removal of the collector.

Alternatively, you can run the Powershell command below to uninstall the collector.
Alternatively, Powershell command below may be run to uninstall the collector.
```pwsh
(Get-WmiObject -Class Win32_Product -Filter "Name = 'observiq-collector'").Uninstall()
```
Binary file removed docs/screenshots/start-service.png
Binary file not shown.
Binary file removed docs/screenshots/stop-restart-service.png
Binary file not shown.
File renamed without changes
Binary file added docs/screenshots/windows/start-service.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes

0 comments on commit eabd9f8

Please sign in to comment.