Files
simple-aircraft-manager-rails/docs/guide/getting-started.md
T
rickyandClaude Opus 5.5 3f45b557c2 Secondary actions behind More menus; tidier aircraft header and tabs
- more_menu helper (menu / menu-item styles): each section keeps its main
  action as a button; imports, exports, printing and tools move under More
  (flights, logbook, logbook entry, documents, inspections, fleet)
- Aircraft header: More with status report and, for owners, access &
  sharing, edit, .sam.zip and records package; Access & Sharing and Oil
  Analysis tabs removed (oil analysis is under Oil & Fuel with a switch)
- Logbook: Print selected appears once an entry is ticked; filters apply on
  change; dates use fmt_date (also AirTrail, notes, audits, About)
- Header shows the role on the aircraft and hides the usual Available badge;
  no second Grounded badge on the Overview; AD DRS import listed once
- Flights: stat cards 2x2 on phones; By year opens visibly, only with more
  than one year; duplicate + Log Flight removed
- Remove unused hello_controller.js; guide and README updated

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 21:21:57 -05:00

48 lines
2.8 KiB
Markdown

# Getting started
## Signing in
Depending on how the app is set up, you can sign in with:
- **Email and password.** Your administrator creates your account. Use **Forgot password?** to reset it if email is set up; otherwise ask the administrator.
- **Email me a sign-in link.** Enter your email and use the link sent to you. It works once, for a short time.
- **Single sign-on** (for example *Sign in with Authentik*), if your organization uses it.
If you've set up an authenticator app (see [Your profile](profile.md#two-factor-sign-in)), signing in with a password or an emailed link then asks for its 6-digit code.
After 10 failed tries in a row (wrong passwords or codes), an account is locked for 15 minutes and its owner is emailed. Wait, or ask the administrator to unlock it.
The very first visit to a new installation asks for the administrator account instead.
## Roles
What you can do depends on your role on each aircraft:
| | Pilot | Owner | Admin |
|---|:-:|:-:|:-:|
| See everything on the aircraft | ✓ | ✓ | ✓ |
| Log flights, update hours, report squawks, add notes, oil and fuel | ✓ | ✓ | ✓ |
| Defer a squawk as inoperative | ✓ | ✓ | ✓ |
| Sign logbook entries (with your own certificate) | ✓ | ✓ | ✓ |
| Edit squawks and notes, resolve squawks | | ✓ | ✓ |
| Components, logbook, inspections, ADs, documents, major records, W&B | | ✓ | ✓ |
| Edit the aircraft, manage people and share links | | ✓ | ✓ |
| Users, settings, procedures and audits for the whole app | | | ✓ |
Anyone can add an aircraft and becomes its owner. You only see aircraft you have a role on; admins see all of them.
## Finding your way around
- **Fleet** (top left) lists your aircraft with their airworthiness.
- Each aircraft has tabs: **Overview, Components, Squawks, Flights, Oil & Fuel, Logbook, Inspections, ADs, Documents, Major Records, W&B, Notes, Activity**.
- **Log Flight** and **Report Squawk** are at the top of every aircraft page. Next to them, **More** has the status report and, for owners, **Access & sharing**, editing the aircraft, and its downloads.
- Each section shows its main action as a button (such as **+ New Entry**). Less frequent ones, such as imports, exports and printing, are under that section's **More** button.
- **Search** (the box in the top bar, or ☰ → Search on a phone) looks through the logbook, squawks, notes, ADs, documents (including the text of their pages), components, flights and major records of your aircraft at once.
- Your name (or ☰ on a phone) leads to your **Profile**, this **Help**, and for admins the **Admin** pages.
## On a phone
The app works on phones. The tabs collapse into a **Section** menu, and wide tables scroll sideways. You can install it like an app: in Safari use **Share → Add to Home Screen**, in Chrome **Install app**.
The sun/moon button switches between light and dark themes.