Skip to content

feat(home): How OneUptime works shows how a problem moves through OneUptime, and every product it has - #8999

Merged
simlarsen merged 10 commits into
mainfrom
claude/how-oneuptime-works-overview
Nov 16, 2026
Merged

simlarsen merged 10 commits into
mainfrom
claude/how-oneuptime-works-overview

Conversation

@simlarsen

Copy link
Copy Markdown
Contributor

What changed, and why

"How OneUptime works" (Help, Home's Explore OneUptime, Search) named four products and then said, in one dense sentence, that telemetry and infrastructure "feed the loop" and everything else was optional. People asked it to show what OneUptime can actually do, more simply and more interactively (#8891). It is now a small explorer of the whole product that still opens on the one thing a newcomer needs first: how the pieces fit together.

The new dialog, in words

  • Title and line under it: "How OneUptime works", "Everything OneUptime does, and how it fits together."

  • A list of sections down the side (on a tablet or phone it becomes a row of pills that scrolls sideways inside the dialog): How it fits together first, then, under a small "Products" label, every category of the Products menu with how many products it holds: Essentials 7, Observability 8, Security 2, AI 2, Code 1, Resources 5, Infrastructure 12, Cloud 3, Dashboards & Automation 4. Just seeing that list answers "what else can OneUptime do?".

  • How it fits together (the first view): "From the first sign of trouble to the fix, every problem moves through four steps", then a numbered, connected timeline:

    1. Detect: check your websites, APIs and servers around the clock, and watch your telemetry and infrastructure for problems (the two words keep their Glossary definitions on hover, focus and tap). Products: Monitors, Logs, Metrics, Traces.
    2. Respond: open an incident when users are affected, or an alert for your team, and page whoever is on call. Incidents, Alerts, On-Call.
    3. Communicate: tell your customers what is happening while you fix it, and announce maintenance ahead of time. Status Pages, Scheduled Maintenance.
    4. Improve: track reliability against your targets, learn from each incident and automate the next response. SLOs, Dashboards, Workflows, Runbooks.

    Each product is a small chip with its own icon and colour, and opens its page.

  • A category shows its name, one line saying what it is for ("The servers, containers, clusters, storage and networks you run yourself."), and a grid of product cards (icon, name, what it does, a chevron). A card opens the product.

  • Next:

    at the foot of every section steps through the whole product like a short tour. Under everything: Core Concepts and Glossary (new tab), and Was this clear? where OneUptime may ask.

How it behaves

  • Built from the real catalog. It reads the Products menu's own items (useDashboardNavigationItems) through the same rules as Home's Explore OneUptime (getExploreCategories, getListedItems, withProductMarks), so a product added to the menu shows up here with the same name, words, icon and colour, in every language.
  • Fitted to the project. Products the project hides, or that the server switched off, are left out of the steps and the categories (a category with nothing left has no section). A product the plan cannot use says which plan can ("Growth Plan") before it is opened, as the menu does. With no project picked yet, every product says what it does and opens nothing.
  • Opening a product closes the dialog and goes there (through AppLink, so unsaved work still asks first). Ctrl, Cmd, Shift or Alt opens it in a new tab and leaves the dialog open for the next one. Each opening records how_it_works/product_opened (the product's key and whether it came from a step or a category), documented in Docs/analytics/activation.md.
  • Keyboard: the sections are a real tab list. The focus starts on the first section, the arrow keys walk them both ways and wrap (Left goes on and Right goes back on a Persian or Arabic page), Home and End jump to the ends, only the selected tab is a tab stop, Tab goes on into the section, and Next moves the focus to the next section's tab. A section picked from the foot of a long one is shown from its top. The dialog keeps its height from one section to the next on a wide screen, so the list does not jump under the pointer.
  • Phones, dark mode, right to left: checked in a real browser at 1440, 1280, 900 and 390px, in light and dark, in German and Persian (offline Home fixture with production CSS). Nothing scrolls sideways on a phone; Persian mirrors the layout and numbers the steps in Persian digits.
  • Search (Cmd/Ctrl+K) now also finds it for "features", "capabilities", "all products" and "what can oneuptime do".
  • Every word is translated into all 17 languages, using each language's own words for the products (the menu's names), and the Home Page & Shortcuts docs describe the dialog in all 17 docs languages.

What I chose not to do, and why

  • The Welcome checklist's strip keeps its short four-product version. It lives inside Home's first-run checklist, which the Quickstart work (Improve quickstart by 100x. #8897) is reshaping right now; it still tells the same story in the same order, and the dialog now shares its docs links. I filed Welcome checklist's How OneUptime works strip: tell the four-step story the dialog now tells #8995 for that work to decide whether the strip should adopt the four steps, become a link to the dialog, or go.
  • No search box inside the dialog. Search (Cmd/Ctrl+K) and the Products menu already search every product; a third search would split the habit.
  • No "Not set up" marks. This is an overview of what OneUptime can do, not an audit of the project; the Products menu already says what is not set up.
  • Hidden products stay hidden, as in Explore OneUptime and the Products menu: the project chose to hide them, and the menu's More products keeps them one click away.
  • It always opens on How it fits together, never on the section someone looked at last: the first thing a lost person needs is the map, and the rest is one click or one arrow key away.
  • It stays a dialog. It is opened from Help and Search on any page and returns people where they were; Home already has the full-page version of the catalog (Explore OneUptime). ExploreProducts.tsx is untouched: the dialog reuses its exported getExploreCategories.

Also fixed on the way

  • The tests caught that every step's sentence was handed Detect's two defined words, which made Respond, Communicate and Improve fall back to English in every other language; each sentence now gets only the slots it names (regression test included).
  • Docs lines merged into main recently failed OneWordInSentencesPerThing on main: the Korean notification settings page and upgrade notes said 알림 (a notification) for an alert, which the Korean Dashboard calls 경고 (a menu path, a table row, and a heading with the link to it, whose anchor now stays in step), and Norwegian set a monitor "frakoblet" (Disconnected's word) where Offline is "offline". All fixed.
  • Respond and Detect were dead keys; Respond was still English in 15 languages. They are the step titles now, worded in every language.

Tests

  • New: Common/Tests/App/Dashboard/HowOneUptimeWorksOverview.test.tsx (54 tests): real i18next with the real locale files, the real catalog and the project-products store. It covers the four steps and their products (links into the current project), the defined words, every category with its count and its line, the tab list and keyboard (both arrow pairs, wrapping, Home/End, right to left, Next, focus), opening a product in place or in a new tab and the event it records, hidden, switched-off and plan-locked products, no project, German, Persian, the dialog (description, docs links, Was this clear?, initial focus, closing, reopening on the first section), and the pure helpers (getSectionForKey, getLoopStepProducts, getSlotsOf, scrollBackToStart).
  • Updated: HowOneUptimeWorksAlwaysThere (the dialog's new content, drawn inside a router as App.tsx does), ProductOrientationCopy (the copy scan now reads the dialog's files, so every word stays a key every language words), DashboardCommandPaletteFindsMore (the new Search words), IntroductionDocsFacts (the docs name the four steps in the order the overview draws them), and the browser spec E2E/HomeOverview/HowOneUptimeWorks.spec.ts (12 tests, run locally against the offline fixture: sections, keyboard, opening a product, phone, dark, German, Persian).
  • Run and passing: the suites above plus the guards that read what changed: dark mode (HomeOverviewDarkMode), GlossaryTermsPerPage, ReadingDirectionGuard, NestedControlsGuard, SentencesFromTranslatedPiecesGuard, TranslatedSentenceInRowGuard, ComponentArrowsInRightToLeftPages, DialogPrimaryActionGuard, CardInCardGuard, the hardcoded-strings guard, the analytics catalog and docs tests, every locale guard (DashboardLocalesGuard, OneWordInSentencesPerThing, OneNamePerThingGuard, DashboardWordsInPersian, ArabicLocaleGuards, DashboardFrenchPunctuation, FrenchNoBreakSpacesGuard, EsbuildLocales, DashboardRuntimeLocales and more), the Introduction docs translation and facts suites, and the neighbouring Home, Help, phone-menu and palette suites. HeaderAtTabletWidths.spec.ts and the Home spec's checklist and Explore tests also pass in the browser.

Closes #8891

🤖 Generated with Claude Code

simlarsen and others added 10 commits November 16, 2026 12:44
…Uptime and every product, by category

The dialog named four products and said in one dense sentence that the rest
was optional, so people never learned what else OneUptime does (#8891). It
is now a small explorer: How it fits together first (Detect, Respond,
Communicate, Improve, each a sentence with the products that do it), then
every product of the products menu, one category at a time, each saying
what it does and opening its page. It is built from the products menu's own
catalog (getExploreCategories), so it stays in step with it, leaves out
what the project hides or the server switched off, and names a plan a
product needs before the click.

The Welcome checklist's strip keeps its four products; its dialog-only
props went with the old dialog, and its docs links are shared with the
dialog. Opening a product records how_it_works/product_opened.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Every sentence the overview draws, in each language's own words for the
products, using the menu's names (Korean 경고 for an alert, Italian "log",
Danish "metrikker", Swedish "mätvärden", Simplified Chinese 追踪). Detect
and Respond were keys nothing drew any more: Respond was still English in
fifteen languages, and Danish, Swedish, Russian and Arabic now word Detect
as a step's title alongside the other three.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…nguage, and its chevrons point the way the line reads

Each step's sentence was handed Detect's two defined words, and a sentence
handed a slot it does not name reads as one its language has not worded:
Respond, Communicate and Improve were English on a German page. Each
sentence now gets only the slots it names (getSlotsOf).

Icon already turns a chevron round on a page read right to left, so the
hand-turned rtl:-scale-x-100 turned it back (ReadingDirectionGuard). And
the docs links' test id is named like a test id, not like the copy the
orientation scanner reads as words (HOW_IT_WORKS_*).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…ory, the keyboard, the project's products and every language

A new suite renders the overview and the dialog with the real catalog and
the real locale files: the four steps in order with the products that do
them (links into the current project), the defined words in Detect's
sentence, every category of the products menu with its count and its line,
the tab list's keyboard (both arrow pairs, wrapping, Home and End, the
other way round in Persian) and Next, opening a product in place or in a
new tab (with the event it records), hidden, switched-off and plan-locked
products, no project, German and Persian, and the regression where three
steps' sentences fell back to English.

HowOneUptimeWorksAlwaysThere follows the dialog's new content (and draws
it inside a router, as App.tsx does), and the orientation copy scan now
reads the dialog's two files, so every word they draw stays a key that
every language words.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…with their one word

Two lines merged into main since #8628 and #8767 said what those changes
had retired, and OneWordInSentencesPerThing failed on main: the Korean
notification settings page said 알림 beside an alert's 경고 in one
sentence, and the Norwegian Incoming Request page set a monitor
"frakoblet", Disconnected's word, where Offline is "offline".

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…the keyboard, opening a product, a phone and Persian

The browser suite asked for the old dialog's four list items and its
'feed the loop' sentence. It now checks the four steps and their products,
the focus starting on the first section, the arrow keys, End, Home and
Next, a category's products, a product opening its page and closing the
dialog, the sections as a sideways row inside the dialog on a 390px phone
(the page never scrolls sideways), and Persian with the sections on the
right and Left going on to the next.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…guage

The Home Page & Shortcuts page said only that How OneUptime works stays
one click away. It now says the dialog opens on How it fits together, the
four steps a problem moves through with the products that do each, then
the Products menu's categories, walked with the arrow keys or Next, and
that the project's hidden products are left out - in all 17 docs
languages, each naming the Dashboard's own words in bold. A docs fact pins
the four steps to the order the overview draws them.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
… works

The dialog now lists every product OneUptime has, so "features",
"capabilities", "all products" and "what can oneuptime do" find it in
Search (Cmd/Ctrl+K) beside "how it works" and "overview". The comments
in Help and the products catalog describe what it shows now.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…works-overview

# Conflicts:
#	packages/App/FeatureSet/Dashboard/src/Locales/ar.json
#	packages/App/FeatureSet/Dashboard/src/Locales/da.json
#	packages/App/FeatureSet/Dashboard/src/Locales/de.json
#	packages/App/FeatureSet/Dashboard/src/Locales/en.json
#	packages/App/FeatureSet/Dashboard/src/Locales/es.json
#	packages/App/FeatureSet/Dashboard/src/Locales/fa.json
#	packages/App/FeatureSet/Dashboard/src/Locales/fr.json
#	packages/App/FeatureSet/Dashboard/src/Locales/hi.json
#	packages/App/FeatureSet/Dashboard/src/Locales/it.json
#	packages/App/FeatureSet/Dashboard/src/Locales/ja.json
#	packages/App/FeatureSet/Dashboard/src/Locales/ko.json
#	packages/App/FeatureSet/Dashboard/src/Locales/nl.json
#	packages/App/FeatureSet/Dashboard/src/Locales/no.json
#	packages/App/FeatureSet/Dashboard/src/Locales/pt.json
#	packages/App/FeatureSet/Dashboard/src/Locales/ru.json
#	packages/App/FeatureSet/Dashboard/src/Locales/sv.json
#	packages/App/FeatureSet/Dashboard/src/Locales/zh-CN.json
#	packages/App/FeatureSet/Dashboard/src/Locales/zh-TW.json
…rean Dashboard does

Two lines merged into main said 알림 (a notification) for Alerts beside
경고 everywhere else, and OneWordInSentencesPerThing failed on main: the
menu path to an alert's AI settings, the re-investigation cooldown's row,
and the heading about new incidents' and alerts' fixes, with the link to
it, which now keeps its anchor in step.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@simlarsen
simlarsen merged commit a0a532e into main Nov 16, 2026
0 of 5 checks passed
@simlarsen
simlarsen deleted the claude/how-oneuptime-works-overview branch November 16, 2026 13:22
@simlarsen

Copy link
Copy Markdown
Contributor Author

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make this modal a lot better.

1 participant