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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#397 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@pulsingSignal y travaille déjà.

Depuis le 5/11/2026.

  • #1 par @pulsingSignal — ouverte
  • #398 par @pulsingSignal — ouverte

Évaluation

Difficulté
1/5
Temps estimé
1-3 heures
Accessibilité débutants
88/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
html, markdown, terraform
Domaine
documentation

Piste de recherche

La modification se limite à docs/ddg.md : le tableau d'en-tête aux lignes 5-9 et le tableau des Variables aux lignes 66-78. Remplacez chaque paire <strong> en ligne par les marqueurs Markdown **, convertissez les deux liens <a href> des lignes 68 et 70 en liens Markdown, et remplacez le <br/> de la ligne 71 par un espace. C'est terminé lorsque grep -nE '</?(strong|a|br)\b' docs/ddg.md ne renvoie rien et que les tableaux s'affichent toujours correctement sur GitHub.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
HCL
Étoiles
61
Forks
28
Merge moyen
1 j 16 h
PR mergées (30 j)
77

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de google/stellar-engine

Toutes les issues de google/stellar-engine

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.