Skip to content

Commit 238eb63

Browse files
committed
fix: screenshot link anchors
1 parent 1f829cc commit 238eb63

File tree

6 files changed

+125
-123
lines changed

6 files changed

+125
-123
lines changed

docs/ui/index.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@ sidebar_position: 1
77
Upon logging in, you are greeted with your [Inventory](./inventory.mdx), providing immediate access to essential search tools and insights. This is assuming that your administrator has already added at least one cloud account. If not you would be greeted with the "Add Cloud Account" screen.
88

99
<BrowserWindow
10-
imageSrc={require('./img/workspace_settings_menu.png').default}
11-
mapName="screenshot-map"
12-
areas={[
13-
{ shape: "rect", coords: "2420,19,2522,107", href: "/ui/user", alt: "User Settings" },
14-
{ shape: "rect", coords: "0,145,590,269", href: "/ui/inventory", alt: "Inventory" },
15-
{ shape: "rect", coords: "0,280,590,411", href: "/ui/security", alt: "Security" },
16-
{ shape: "rect", coords: "0,1078,590,1189", href: "/ui/workspace#workspace-settings", alt: "Workspace Settings" },
17-
{ shape: "rect", coords: "0,1198,590,1313", href: "/ui/workspace#workspace-accounts", alt: "Accounts" },
18-
{ shape: "rect", coords: "0,1327,590,1440", href: "/ui/workspace#workspace-users", alt: "Users" },
19-
{ shape: "rect", coords: "0,1449,590,1568", href: "/ui/workspace#workspace-billing", alt: "Billing" },
20-
{ shape: "rect", coords: "2060,182,2264,256", href: "/ui/inventory#inventory-search-easy", alt: "Easy Search" },
21-
{ shape: "rect", coords: "2273,180,2513,254", href: "/ui/inventory#inventory-search-advanced", alt: "Advanced Search" },
22-
{ shape: "rect", coords: "635,419,2494,1588", href: "/ui/inventory#inventory-overview", alt: "Example Searches" },
23-
{ shape: "rect", coords: "642,288,1640,381", href: "/ui/inventory#inventory-overview", alt: "Search Properties" }
24-
]}
10+
imageSrc={require('./img/workspace_settings_menu.png').default}
11+
mapName="screenshot-map"
12+
areas={[
13+
{ shape: "rect", coords: "2420,19,2522,107", href: "/ui/user", alt: "User Settings" },
14+
{ shape: "rect", coords: "0,145,590,269", href: "/ui/inventory", alt: "Inventory" },
15+
{ shape: "rect", coords: "0,280,590,411", href: "/ui/security", alt: "Security" },
16+
{ shape: "rect", coords: "0,1078,590,1189", href: "/ui/workspace", alt: "Workspace Settings" },
17+
{ shape: "rect", coords: "0,1198,590,1313", href: "/ui/workspace#cloud-accounts", alt: "Accounts" },
18+
{ shape: "rect", coords: "0,1327,590,1440", href: "/ui/workspace#users", alt: "Users" },
19+
{ shape: "rect", coords: "0,1449,590,1568", href: "/ui/workspace#billing", alt: "Billing" },
20+
{ shape: "rect", coords: "2060,182,2264,256", href: "/ui/inventory#search", alt: "Easy Search" },
21+
{ shape: "rect", coords: "2273,180,2513,254", href: "/ui/inventory#advanced-search", alt: "Advanced Search" },
22+
{ shape: "rect", coords: "635,419,2494,1588", href: "/ui/inventory", alt: "Example Searches" },
23+
{ shape: "rect", coords: "642,288,1640,381", href: "/ui/inventory", alt: "Search Properties" }
24+
]}
2525
/>
2626

2727
- In the top right you find options to switch between light and dark mode for your viewing preference, change the interface language, and access the [user menu](./user.mdx).

docs/ui/inventory.mdx

Lines changed: 43 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,90 @@
11
# Inventory
22

3+
The Inventory screen is where you can search through your entire cloud infrastructure. You can perform a full-text search to find specific resources and use filters to refine your search by account and other properties. The screen also allows you to switch between a Form-based search for guided queries and an Advanced search for free-form search inputs. In the center, you have a list of example searches that highlight common queries to help you quickly identify issues or resources within your environment.
4+
35
<BrowserWindow
4-
imageSrc={require('./img/inventory_closed.png').default}
5-
alt="Inventory Overview"
6-
url="https://app.fix.security/inventory"
7-
id="inventory-overview"
6+
imageSrc={require('./img/inventory_closed.png').default}
7+
alt="Inventory Overview"
8+
url="https://app.fix.security/inventory"
9+
id="inventory-overview"
810
/>
911

10-
This is the Inventory screen, where you can search through your entire cloud infrastructure. You can perform a full-text search to find specific resources and use filters to refine your search by account and other properties. The screen also allows you to switch between a Form-based search for guided queries and an Advanced search for free-form search inputs. In the center, you have a list of example searches that highlight common queries to help you quickly identify issues or resources within your environment.
12+
## Search
1113

12-
## Search results
14+
Search results are displayed in a columnar format for easy viewing and analysis. Each result is presented with a set of default columns, including the kind, ID, name, volume status, last access, age, cloud, and account. Additionally, any column that is part of your search filter is automatically included in this view. On the right side, there is a download button that allows you to export all the results as a CSV file, enabling further analysis and reporting outside the application.
1315

1416
<BrowserWindow
15-
imageSrc={require('./img/inventory_search_easy.png').default}
16-
alt="Inventory Search Easy"
17-
url="https://app.fix.security/inventory"
18-
id="inventory-search-easy"
17+
imageSrc={require('./img/inventory_search_easy.png').default}
18+
alt="Inventory Search Easy"
19+
url="https://app.fix.security/inventory"
20+
id="inventory-search-easy"
1921
/>
2022

21-
The search results are displayed in a columnar format for easy viewing and analysis. Each result is presented with a set of default columns, including the kind, ID, name, volume status, last access, age, cloud, and account. Additionally, any column that is part of your search filter is automatically included in this view. On the right side, there is a download button that allows you to export all the results as a CSV file, enabling further analysis and reporting outside the application.
23+
### Advanced search
24+
25+
This is the same search using the advanced search feature. Here you can enter free-form search queries.
2226

2327
<BrowserWindow
24-
imageSrc={require('./img/inventory_search_advanced.png').default}
25-
alt="Inventory Search Advanced"
26-
url="https://app.fix.security/inventory"
27-
id="inventory-search-advanced"
28+
imageSrc={require('./img/inventory_search_advanced.png').default}
29+
alt="Inventory Search Advanced"
30+
url="https://app.fix.security/inventory"
31+
id="inventory-search-advanced"
2832
/>
2933

30-
This is the same search using the advanced search feature. Here you can enter free-form search queries.
31-
3234
## Resource details
3335

3436
<BrowserWindow
35-
imageSrc={require('./img/inventory_resource.png').default}
36-
alt="Inventory Resource Neighbors"
37-
url="https://app.fix.security/inventory"
38-
id="inventory-resource-neighbors"
37+
imageSrc={require('./img/inventory_resource.png').default}
38+
alt="Inventory Resource Neighbors"
39+
url="https://app.fix.security/inventory"
40+
id="inventory-resource-neighbors"
3941
/>
4042

4143
Clicking on any row in the search results opens the Resource View. At the top of this view, you will see a Neighborhood Map, which visually displays the connections between the selected resource and other resources in your infrastructure. This helps you understand the relationships and dependencies between various components.
4244

4345
<BrowserWindow
44-
imageSrc={require('./img/inventory_basic_information.png').default}
45-
alt="Inventory Resource Basic Information"
46-
url="https://app.fix.security/inventory"
47-
id="inventory-resource-basic-information"
46+
imageSrc={require('./img/inventory_basic_information.png').default}
47+
alt="Inventory Resource Basic Information"
48+
url="https://app.fix.security/inventory"
49+
id="inventory-resource-basic-information"
4850
/>
4951

5052
Below the Neighborhood Map, you will find the Basic Information section. This section provides key details about the resource, such as its name, and which account and region it resides in, giving you a quick overview of the resource's essential attributes.
5153

5254
Further down, you will see the Tags section. This area lists all the tags and their values, associated with the resource.
5355

5456
<BrowserWindow
55-
imageSrc={require('./img/inventory_details.png').default}
56-
alt="Inventory Resource Details"
57-
url="https://app.fix.security/inventory"
58-
id="inventory-resource-details"
57+
imageSrc={require('./img/inventory_details.png').default}
58+
alt="Inventory Resource Details"
59+
url="https://app.fix.security/inventory"
60+
id="inventory-resource-details"
5961
/>
6062

6163
Scrolling down even further, you can unfold the Resource Details section. This section shows every property of the resource in detail. Any of these properties can be [searched for](../search-syntax/filters.mdx#selecting-nodes-by-predicate).
6264

6365
<BrowserWindow
64-
imageSrc={require('./img/inventory_security_issues.png').default}
65-
alt="Inventory Resource Issues & Changes"
66-
url="https://app.fix.security/inventory"
67-
id="inventory-resource-issues-changes"
66+
imageSrc={require('./img/inventory_security_issues.png').default}
67+
alt="Inventory Resource Issues & Changes"
68+
url="https://app.fix.security/inventory"
69+
id="inventory-resource-issues-changes"
6870
/>
6971

7072
Further down, you will find sections for Security Issues and Changes. The Security Issues section highlights any security concerns related to the resource, such as non-compliance with security policies.
7173

7274
<BrowserWindow
73-
imageSrc={require('./img/inventory_changes.png').default}
74-
alt="Inventory Resource Issues & Changes"
75-
url="https://app.fix.security/inventory"
76-
id="inventory-resource-issues-changes"
75+
imageSrc={require('./img/inventory_changes.png').default}
76+
alt="Inventory Resource Issues & Changes"
77+
url="https://app.fix.security/inventory"
78+
id="inventory-resource-issues-changes"
7779
/>
7880

7981
The Changes timeline provides a historical record of changes made to the resource, including the creation date and any detected security issues, allowing you to track its lifecycle and changes over time.
8082

8183
<BrowserWindow
82-
imageSrc={require('./img/inventory_config_diff.png').default}
83-
alt="Inventory Resource Config Diff"
84-
url="https://app.fix.security/inventory"
85-
id="inventory-resource-config-diff"
84+
imageSrc={require('./img/inventory_config_diff.png').default}
85+
alt="Inventory Resource Config Diff"
86+
url="https://app.fix.security/inventory"
87+
id="inventory-resource-config-diff"
8688
/>
8789

8890
Clicking on one of the "Configuration changed" entries in the Changes timeline, shows you the configuration differences between the selected version and the previous one. This allows you to see what has changed and when.

docs/ui/security/benchmark.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
Clicking on a benchmark opens the detailed Benchmark View, which shows the status of various security controls and their compliance with the selected framework.
44

55
<BrowserWindow
6-
imageSrc={require('../img/benchmark_view.png').default}
7-
alt="Benchmark View"
8-
url="https://app.fix.security/benchmark/iso27001"
9-
id="benchmark-view"
6+
imageSrc={require('../img/benchmark_view.png').default}
7+
alt="Benchmark View"
8+
url="https://app.fix.security/benchmark/iso27001"
9+
id="benchmark-view"
1010
/>
1111

1212
### Control list
@@ -26,19 +26,19 @@ The table lists the failing checks with details such as severity, the number of
2626
When you open a section on the left and click on a specific control, detailed information about that control, as well as the affected resources, is displayed.
2727

2828
<BrowserWindow
29-
imageSrc={require('../img/benchmark_details.png').default}
30-
alt="Benchmark Details"
31-
url="https://app.fix.security/benchmark/iso27001"
32-
id="benchmark-details"
29+
imageSrc={require('../img/benchmark_details.png').default}
30+
alt="Benchmark Details"
31+
url="https://app.fix.security/benchmark/iso27001"
32+
id="benchmark-details"
3333
/>
3434

3535
### Control information
3636

3737
On the top of the right side, you see detailed information about the selected control. This includes:
3838

39-
- Control Name: The specific control being examined, e.g., "Ensure All AWS RDS Cluster and Instance Snapshots Are Encrypted."
40-
- Description: An explanation of the control, defining its purpose and the rules for effective cryptography, such as using key management to secure data during storage and transmission.
41-
- Link to Inventory: The "Inspect Detection Search in Inventory" button takes you to the [Inventory](../inventory.mdx) screen, using the same search this control uses to identify affected resources.
39+
- **Control Name:** The specific control being examined, e.g., "Ensure All AWS RDS Cluster and Instance Snapshots Are Encrypted."
40+
- **Description:** An explanation of the control, defining its purpose and the rules for effective cryptography, such as using key management to secure data during storage and transmission.
41+
- **Link to Inventory:** The "Inspect Detection Search in Inventory" button takes you to the [Inventory](../inventory.mdx) screen, using the same search this control uses to identify affected resources.
4242

4343
### Why does it matter?
4444

@@ -57,10 +57,10 @@ This table lists the resources impacted by the failing control. Clicking on a re
5757
Clicking on an affected resource in the Benchmark Control Details opens the Resource View, providing in-depth information about the selected resource.
5858

5959
<BrowserWindow
60-
imageSrc={require('../img/benchmark_resource.png').default}
61-
alt="Benchmark Resource"
62-
url="https://app.fix.security/benchmark/iso27001"
63-
id="benchmark-resource"
60+
imageSrc={require('../img/benchmark_resource.png').default}
61+
alt="Benchmark Resource"
62+
url="https://app.fix.security/benchmark/iso27001"
63+
id="benchmark-resource"
6464
/>
6565

6666
This view is identical to the [Inventory Resource View](../inventory.mdx#resource-details), with the same sections for Basic Information, Tags, Resource Details, Security Issues, and Changes.

docs/ui/security/index.mdx

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
The Security Dashboard provides a comprehensive overview of your cloud infrastructure's security status and recent changes.
44

55
<BrowserWindow
6-
imageSrc={require('../img/security_dashboard_closed.png').default}
7-
alt="Security Dashboard"
8-
url="https://app.fix.security/security"
9-
id="security-dashboard"
6+
imageSrc={require('../img/security_dashboard_closed.png').default}
7+
alt="Security Dashboard"
8+
url="https://app.fix.security/security"
9+
id="security-dashboard"
1010
/>
1111

1212
### Security score
@@ -32,34 +32,34 @@ This section shows the number of resources that have been improved or remediated
3232
The Benchmarks matrix provides a visual representation of the compliance scores for different security frameworks across your various cloud accounts. Each cell in the matrix corresponds to a specific account and framework, displaying a score that indicates how well that account adheres to the specified framework's standards.
3333

3434
<BrowserWindow
35-
imageSrc={require('../img/security_dashboard_benchmarks.png').default}
36-
alt="Security Dashboard Benchmarks"
37-
url="https://app.fix.security/security"
38-
id="security-dashboard-benchmarks"
35+
imageSrc={require('../img/security_dashboard_benchmarks.png').default}
36+
alt="Security Dashboard Benchmarks"
37+
url="https://app.fix.security/security"
38+
id="security-dashboard-benchmarks"
3939
/>
4040

4141
Clicking on a benchmark or on a score will open the [Benchmark Details](./benchmark.mdx) view, providing a detailed breakdown which controls are passing or failing, and the severity of the issues detected.
4242

4343
## Timeline
4444

45+
The Failing Check Timeline provides a visual representation of how your security posture has changed over time.
46+
4547
<BrowserWindow
46-
imageSrc={require('../img/security_dashboard_timeline.png').default}
47-
alt="Security Dashboard Timeline"
48-
url="https://app.fix.security/security"
49-
id="security-dashboard-timeline"
48+
imageSrc={require('../img/security_dashboard_timeline.png').default}
49+
alt="Security Dashboard Timeline"
50+
url="https://app.fix.security/security"
51+
id="security-dashboard-timeline"
5052
/>
5153

52-
The Failing Check Timeline provides a visual representation of how your security posture has changed over time.
53-
5454
## Accounts summary
5555

56+
The Accounts Summary provides a detailed overview of your security scores on a per-account basis. Each account is represented with its respective security score, helping you quickly assess the security posture of each cloud account in your workspace.
57+
5658
<BrowserWindow
57-
imageSrc={require('../img/security_dashboard_accounts_summary.png').default}
58-
alt="Security Dashboard Accounts Summary"
59-
url="https://app.fix.security/security"
60-
id="security-dashboard-accounts-summary"
59+
imageSrc={require('../img/security_dashboard_accounts_summary.png').default}
60+
alt="Security Dashboard Accounts Summary"
61+
url="https://app.fix.security/security"
62+
id="security-dashboard-accounts-summary"
6163
/>
6264

63-
The Accounts Summary provides a detailed overview of your security scores on a per-account basis. Each account is represented with its respective security score, helping you quickly assess the security posture of each cloud account in your workspace.
64-
6565
Hovering over an account will display a detailed breakdown of the security score, including the number of critical, high, medium, and low severity issues detected in that account.

docs/ui/user.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# User settings
22

3-
<BrowserWindow
4-
imageSrc={require('./img/workspace_list.png').default}
5-
alt="Workspace selection"
6-
/>
7-
83
Clicking the user icon in the top right corner shows the user menu, where you can switch between workspaces you're a member of and open the user settings.
94

105
<BrowserWindow
11-
imageSrc={require('./img/user_settings.png').default}
12-
alt="Workspace selection"
13-
url="https://app.fix.security/user-settings"
14-
id="user-settings"
6+
imageSrc={require('./img/workspace_list.png').default}
7+
alt="Workspace selection"
158
/>
169

1710
The User Settings screen allows you to manage your personal account information and security settings. You can update your email address, change your password, and activate Two-Factor Authentication (TOTP). Additionally, you can customize your notification preferences and manage connected accounts, enabling you to log in with Google or GitHub.
11+
12+
<BrowserWindow
13+
imageSrc={require('./img/user_settings.png').default}
14+
alt="Workspace selection"
15+
url="https://app.fix.security/user-settings"
16+
id="user-settings"
17+
/>

0 commit comments

Comments
 (0)