Skip to content

Commit d0edba1

Browse files
committed
docs: update usage and installation
1 parent b5d2c0b commit d0edba1

3 files changed

Lines changed: 17 additions & 26 deletions

File tree

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,45 +20,41 @@ Apex Log Analyzer makes performance analysis of Salesforce debug logs much easie
2020
> Higher log levels result in higher reported execution time than would be seen with logging off.\
2121
> This is due to the over head associated with logging method entry and exit.
2222
23-
[Installation](#installation 'Go to Installation') |
24-
[Usage](#usage 'Go to Usage') |
23+
[Getting Started](#getting-started 'Go to Getting Started') |
2524
[Features](#features 'Go to Features') |
2625
[Settings](#settings 'Go to Settings') |
2726
[Explore the Docs](https://certinia.github.io/debug-log-analyzer/) |
2827
[Contributing](#contributing 'Go to Contributing') |
2928
[Contributors](#contributors 'Go to Contributors') |
3029
[License](#license 'Go to License')
3130

32-
## Installation
31+
## Getting Started
32+
33+
### Installation
3334

3435
![install](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/v1.10/install-lana.webp)
3536

36-
- Search for `Apex Log Analyzer` in extensions.
37-
- Click install + then reload VSCode.
37+
Search for `Apex Log Analyzer` from the extensions side bar in VS Code and click `Install` or
38+
install from the VS Code market place by clicking install on [Visual Studio Code Market Place: Apex Log Analyzer](https://marketplace.visualstudio.com/items?itemName=financialforce.lana)
3839

3940
### Pre-Release
4041

4142
Click `Switch to Pre-Release Version` on the banner to get bleeding edge changes and help us to resolve bugs before the stable release.
4243

4344
### Command Pallette
4445

45-
- Open command pallette (CMD/CTRL + Shift + P), paste `ext install financialforce.lana`, and press enter.
46-
- Click reload in the extensions tab.
46+
Open command pallette (CMD/CTRL + Shift + P), paste `ext install financialforce.lana`, and press enter.
4747

4848
```sh
4949
ext install financialforce.lana
5050
```
5151

52-
### VSCode Marketplace
53-
54-
- Install from the VSCode market place by clicking install on [Visual Studio Code Market Place: Apex Log Analyzer](https://marketplace.visualstudio.com/items?itemName=financialforce.lana)
55-
56-
## Usage
52+
### Show Analysis
5753

58-
Start the analysis either from a log you have already downloaded or by downloading a log from an org to view.
54+
Start the analysis either from a log you have already downloaded or by downloading a log from an org.
5955
On larger logs the analysis window make take a few seconds to appear.
6056

61-
### From an Open Log File
57+
#### From an Open Log File
6258

6359
With the `.log` file open in VSCode.
6460

@@ -73,7 +69,7 @@ With the `.log` file open in VSCode.
7369
or
7470
1. Right click editor tab -> 'Log: Show Apex Log Analysis'
7571

76-
### Download a log
72+
#### Download a log
7773

7874
1. Open command pallette (CMD/CTRL + Shift + P) -> 'Log: Retrieve Apex Log And Show Analysis
7975

lana-docs-site/docs/docs/usage.md renamed to lana-docs-site/docs/docs/gettingstarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 3
33
---
44

5-
# Usage
5+
# Getting Started
66

77
Start the analysis either from a log you have already downloaded or by downloading a log from an org to view.
88
On larger logs the analysis window make take a few seconds to appear.

lana-docs-site/docs/docs/installation.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,17 @@ sidebar_position: 2
66

77
![install](https://raw.githubusercontent.com/certinia/debug-log-analyzer/main/lana/dist/v1.10/install-lana.webp)
88

9-
- Search for `Apex Log Analyzer` in extensions.
10-
- Click install + then reload VSCode.
9+
Search for `Apex Log Analyzer` from the extensions side bar in VS Code and click `Install` or
10+
install from the VS Code market place by clicking install on [Visual Studio Code Market Place: Apex Log Analyzer](https://marketplace.visualstudio.com/items?itemName=financialforce.lana)
1111

12-
## Pre-Release
12+
### Pre-Release
1313

1414
Click `Switch to Pre-Release Version` on the banner to get bleeding edge changes and help us to resolve bugs before the stable release.
1515

16-
## Command Pallette
16+
### Command Pallette
1717

18-
- Open command pallette (CMD/CTRL + Shift + P), paste `ext install financialforce.lana`, and press enter.
19-
- Click reload in the extensions tab.
18+
Open command pallette (CMD/CTRL + Shift + P), paste `ext install financialforce.lana`, and press enter.
2019

2120
```sh
2221
ext install financialforce.lana
2322
```
24-
25-
## VSCode Marketplace
26-
27-
- Install from the VSCode market place by clicking install on [Visual Studio Code Market Place: Apex Log Analyzer](https://marketplace.visualstudio.com/items?itemName=financialforce.lana)

0 commit comments

Comments
 (0)