[Documentation] docs/ddg.md: the header and Variables tables use inline HTML, which Google Docs now shows as raw text

Aperta Adatta ai principianti
  • Qualcosa non va?
#397 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@pulsingSignal ci sta già lavorando.

Dal 5/11/2026.

  • #1 di @pulsingSignal — aperta
  • #398 di @pulsingSignal — aperta

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
html, markdown, terraform
Ambito
documentation

Direzione di ricerca

La modifica riguarda solo docs/ddg.md: la tabella di intestazione alle righe 5-9 e la tabella delle Variabili alle righe 66-78. Sostituisci ogni coppia inline <strong> con i marcatori Markdown **, converti i due link <a href> alle righe 68 e 70 in link Markdown e sostituisci il <br/> alla riga 71 con uno spazio. È completato quando grep -nE '</?(strong|a|br)\b' docs/ddg.md non restituisce nulla e le tabelle vengono ancora visualizzate correttamente su GitHub.

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

Descrizione

Documentation Level of Effort - Low Priority - Low

Description of Documentation Need

Since 2026-10-05, Google Drive and Docs open Markdown files natively (Workspace Updates). An uploaded .md now stays an .md file and opens in Markdown mode, where, per Google's help page, "Web formatting (.HTML) turns into plain text". Until then, Drive converted an uploaded .md into a Google Doc. There is no admin or user setting to restore the old behavior.

Many operators fill in the DDG in Google Docs; the guide asks for a copy before the Variables table is filled in (line 34, "Please make a copy of this deployment guide before filling out the variable section below"). docs/ddg.md builds both of its tables with inline HTML. Line numbers are from main @ 2267b973:

  • <strong> around every label: 23 tags, in the header table (lines 5–9) and the Variables table (lines 66–78)
  • <a href='…'> for two links: line 68 (Console Link) and line 70 (compliance regime)
  • a <br/> in the Customer ID description (line 71)

GitHub renders these, so the file looks right in the repo. In Google Docs every row of the Variables table reads <strong>Billing Account</strong>, <strong>Prefix</strong> and so on. That happens both in Markdown mode and in the Google Doc that File > Save as Google Docs makes from it. PR #386's current head (93db8b7e) still carries all of them.

Target Audience

Operators and partners who work through the DDG in Google Docs, which is where the Variables table is filled in.

Proposed Location

docs/ddg.md: the header table (lines 5–9) and the Variables table (lines 66–78). No other file is involved.

Content Outline / Draft

Plain Markdown for the same formatting:

  1. <strong>X</strong> → **X** (23 places).
  2. Line 68: <a href='https://console.cloud.google.com/billing'>Console Link</a> → [Console Link](https://console.cloud.google.com/billing).
  3. Line 70: <a href='https://assuredworkloads.googleapis.com/$discovery/rest?version=v1'>compliance regime</a> → [compliance regime](https://assuredworkloads.googleapis.com/$discovery/rest?version=v1).
  4. Line 71: <br/> → a space. A table cell cannot hold a Markdown line break, and the sentence reads the same without it.

Optionally, a docs check such as grep -nE '</?(strong|a|br)\b' docs/*.md would keep inline HTML out of the guides.

Compliance Context (if applicable)

None. This is formatting only; no value, control or step changes.

Lingua principale
HCL
Stelle
61
Fork
28
Merge medio
1g 17h
PR unite (30g)
74

Preparare l'ambiente

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 google/stellar-engine

Tutte le issue di google/stellar-engine

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.