Console Guide
The Console Guide is a surface-by-surface reference for the MaxoPerf application. Each guide documents one top-level navigation area and covers every inner tab as its own section — so you can open the guide for the page you are looking at and learn exactly how to use it.
This guide is about using the product surfaces. For the craft of writing and structuring performance tests, see the Testing Academy. For task-focused how-to workflows (e.g. “run your first test”), see the How-to guides.
How this guide is organised
Section titled “How this guide is organised”The guides follow the console’s left navigation, top to bottom:
| Guide | Console nav area | Inner tabs / sections |
|---|---|---|
| Navigating the console | Shell (all pages) | Left nav, Top bar, Account switcher, Workspace scope, Global search, Dashboard home |
| Ideas Portal | Ideas Portal (/ideas) | Ideas list, Submit idea, Upvote |
| Projects | Projects (/projects) | Project list, Create project, Project detail |
| Secrets | Secrets (/secrets) | Secrets list, Add/edit secret, Workspace secrets |
| Tests — create and configure | Tests (/tests) | All tests list, New test wizard, Test detail — Overview, Configuration, Data, Schedule |
| Runs — read results | Runs (/runs) | Runs list, Run detail — Overview, Metrics, Criteria, Runner status, Configuration, Errors, Logs, Artifacts |
| Private datacenters | Private datacenters (/private-datacenters) | Datacenter list, Install guide, Status |
| Account overview & active runs | Account → Overview, Active runs | Overview metrics, Active runs list |
| Workspaces | Account → Workspaces (/workspaces) | Workspace list, Create workspace, Workspace settings |
| Teams | Account → Teams (/account/teams) | Teams list, Create team, Team membership |
| Members & invites | Account → Members (/account/members) | Member list, Invite flow, Role management |
| Billing | Billing (/billing) | Usage, Plans, Payment method, Invoices |
| Settings | Settings — Profile, Notifications, API keys | Profile, Notifications, API keys |
Fixed page template
Section titled “Fixed page template”Every guide in this section follows the same structure so the manual reads consistently:
## What this is## Where to find it ← exact nav path, e.g. "Tests → select a test → Configuration tab"## <Inner tab A> ← what it does + numbered steps + screenshot## <Inner tab B>## Tips & gotchas## Related docs ← cross-links to Concepts / How-to / Testing Academy / ReferenceAuthors adding new guides or sections must follow this template. The What this is section is one paragraph describing the surface’s purpose. Where to find it gives the exact navigation path. Each inner tab section documents what the tab does, followed by numbered how-to steps and an embedded screenshot. Tips & gotchas surfaces common mistakes and edge cases. Related docs cross-links to overlapping Concepts, How-to, Testing Academy, or Reference pages — never duplicates.
Getting started
Section titled “Getting started”If you are new to the console, start with Navigating the console — it covers the persistent shell (left nav, top bar, account switcher, workspace scope, global search) that appears on every page.