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

未关闭 适合新手
  • 哪里不对？
#397 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1-3 小时
新手友好度
88/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
html, markdown, terraform
领域
documentation

调研方向

此更改仅涉及 docs/ddg.md：第 5-9 行的表头表格和第 66-78 行的 Variables 表格。将每个行内 <strong> 成对标签替换为 Markdown 的 ** 标记，把第 68 和 70 行的两个 <a href> 链接改为 Markdown 链接，并将第 71 行的 <br/> 替换为一个空格。完成标准是 grep -nE '</?(strong|a|br)\b' docs/ddg.md 没有任何输出，并且表格在 GitHub 上仍能正常渲染。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
HCL
星标
61
派生
28
平均合并
1 天 17 小时
30 天内合并 PR
75

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

google/stellar-engine 的其他 Issue

查看 google/stellar-engine 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。