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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#397 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
html, markdown, terraform
Área
documentation

Línea de trabajo

El cambio afecta solo a docs/ddg.md: la tabla de encabezado en las líneas 5-9 y la tabla de Variables en las líneas 66-78. Reemplaza cada par <strong> en línea por los marcadores Markdown **, convierte los dos enlaces <a href> de las líneas 68 y 70 en enlaces Markdown y cambia el <br/> de la línea 71 por un espacio. Está terminado cuando grep -nE '</?(strong|a|br)\b' docs/ddg.md no devuelve nada y las tablas siguen renderizándose bien en GitHub.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Documentation Level of Effort - Low Priority - Medium

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.

Lenguaje dominante
HCL
Estrellas
61
Forks
28
Merge medio
1 d 17 h
PR fusionados (30 d)
75

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de google/stellar-engine

Todos los issues de google/stellar-engine

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.