Cloud getting-started §2 "Verifying your email address" is circular and omits the custom-domain caveat

Aperta Adatta ai principianti
#1,239 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
92/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

Inizia da content/en/cloud/getting-started/getting-started-with-layer5-account.md alla §2, poi leggi la formulazione relativa ai domini personalizzati in content/en/cloud/guides/self-hosted/white-labeling/_index.md. Sostituisci il riferimento circolare con il contenuto dell’e-mail, il comportamento dei domini personalizzati e il rimedio per i link inviati prima della correzione. Il lavoro è completo quando la §2 contiene indicazioni complete per la verifica e l’avvertenza relativa alla pre-release.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

What

content/en/cloud/getting-started/getting-started-with-layer5-account.md §2
("Verifying your email address") has no actual instructions, and its one
sentence refers the reader to the section they are already reading:

### 2. Verifying your email address

To ensure you can use all the features in your Layer5 plan, verify your email
address after signing up for a new account. For more information, see
"Verifying your email address."

That circular reference should become real content, and there is a
custom-domain caveat that currently appears nowhere.

Why now

layer5io/meshery-cloud#6092: on a tenant custom domain (e.g. cloud.meshery.io)
the verification link in the signup email could not be completed. The email was
correct — correctly branded, correctly addressed at the tenant host — but
clicking it redirected to the provider's /error page. Fixed in meshery-cloud;
the user-visible consequences want documenting.

Suggested content for §2

  1. What the email contains — a verification code and a link; either
    completes verification.
  2. Custom domains — the link now keeps you on your organization's own
    domain end to end. This is what
    content/en/cloud/guides/self-hosted/white-labeling/_index.md (the
    "Recipients therefore stay on your domain rather than being sent to the
    canonical Layer5 Cloud host" bullet) already promises for footer links; it
    is now also true of the verification link itself.
  3. Links sent before the fix — a verification email delivered before the
    release carrying meshery-cloud#6092 carries a link that cannot be completed
    on a custom domain. Kratos flow links live 720h (30 days), so such links
    remain in inboxes for up to a month after the release.
    Remedy: request a fresh verification email. There is no way to repair an
    already-sent link — the old link goes straight to the identity service and
    no server hop can intercept it.

Why this is filed rather than submitted as a PR

The meshery-cloud change was made in an isolated worktree whose rules forbid
modifying other checkouts, so the docs half could not ship in the same change
set. Flagging per meshery-cloud AGENTS.md §4 (external documentation in the
same PR) rather than leaving it unrecorded.

Lingua principale
JavaScript
Stelle
99
Fork
226
Merge medio
2g 2h
PR unite (30g)
34

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di layer5io/docs

Tutte le issue di layer5io/docs

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.