Skip to content

fix(docs): add docs.metadata.json for product neutral guides #15960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
scotthart merged 3 commits into from
Feb 18, 2026
+13 −0
Merged

fix(docs): add docs.metadata.json for product neutral guides #15960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8279405
fix(docs): add a docs.metadata.json for product neutral guides
bshaffer Feb 17, 2026
9451406
use template file
bshaffer Feb 17, 2026
b557b42
fix styles and template file
bshaffer Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ci/cloudbuild/builds/publish-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ function stage_docfx() {
local path="${binary_dir}/google/cloud/${feature}/docfx"
if [[ "${feature}" == "common" ]]; then
path="${binary_dir}/google/cloud/docfx"
elif [[ "${feature}" == "guides" ]]; then
path="${binary_dir}/product-neutral-guides/docfx"
fi

echo "path=${path}" >"${log}"
Expand All @@ -119,6 +121,7 @@ io::log "bucket: gs://${docfx_bucket}"
# have documentation, such as `experimental-storage_grpc`. These are harmless,
# as the `stage_docfx()` function skips missing directories without an error.
uploaded=(common)
uploaded+=(guides)
uploaded+=("${FEATURE_LIST[@]}")
echo "${uploaded[@]}" | xargs -P "$(nproc)" -n 1 \
bash -c "stage_docfx \"\${0}\" \"${docfx_bucket}\" cmake-out \"cmake-out/\${0}.docfx.log\""
Expand Down
5 changes: 5 additions & 0 deletions docfx/product-neutral-guides/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ set(TOC_ITEMS ${toc_items})
set(toc_file "${output_dir}/toc.yml")
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/toc.yml.in" "${toc_file}" @ONLY)

set(metadata_file "${output_dir}/docs.metadata.json")
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/docs.metadata.json.in"
"${metadata_file}" @ONLY)
list(APPEND copied_files "${metadata_file}")

add_custom_target(product-neutral-guides-docs DEPENDS ${copied_files})

add_dependencies(all-docfx product-neutral-guides-docs)
5 changes: 5 additions & 0 deletions docfx/product-neutral-guides/docs.metadata.json.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"language": "cpp",
"name": "product-neutral-guides",
"version": "@PROJECT_VERSION@"
}