Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions core/help/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package-lock.json
docs
.vscode
.coverage
__pycache__
9 changes: 9 additions & 0 deletions core/help/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "help",
"name_pretty": "Client library help",
"language": "nodejs",
"repo": "googleapis/google-cloud-node",
"distribution_name": "",
"product_documentation": "https://cloud.google.com/nodejs/docs/reference/help/latest",
"library_type": "OTHER"
}
58 changes: 58 additions & 0 deletions core/help/docs-devsite.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
#!/bin/bash

# Usage: ./docs-devsite.sh

set -e

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DOCS_DIR="$SCRIPT_DIR/docs"
ROOT_DIR="$(cd "$SCRIPT_DIR/../.." && pwd)"

# Copy root README.md to getting-started.md
mkdir -p $DOCS_DIR
echo "Copying root README.md to help/docs/getting-started.md..."
cp "$ROOT_DIR/README.md" "$DOCS_DIR/getting-started.md"

# Generate toc.yaml
echo "Generating toc.yaml in $ABS_DIR..."
TOC_FILE="$DOCS_DIR/toc.yaml"

# Write the top-level structure
echo "-" > "$TOC_FILE"
echo " uid: product-neutral-guides" >> "$TOC_FILE"
echo " name: 'Client library help'" >> "$TOC_FILE"
echo " items:" >> "$TOC_FILE"
echo " -" >> "$TOC_FILE"
echo " name: 'Getting started'" >> "$TOC_FILE"
echo " href: getting-started.md" >> "$TOC_FILE"

# Find .md files and append to TOC
for f in $(ls "$ROOT_DIR"/docs/*.md | sort); do
if [ -f "$f" ]; then
filename=$(basename "$f")
echo "Copying $filename to help/docs/$filename..."
cp $f $DOCS_DIR
case "$filename" in
"authentication.md")
name="Authentication"
;;
"faq.md")
name="FAQ"
;;
"troubleshooting.md")
name="Troubleshooting"
;;
"getting-started.md")
name="Getting Started"
;;
*)
name="${filename%.md}" # Fallback
name="$(echo "$name" | awk '{print toupper(substr($0,1,1))substr($0,2)}')"
;;
esac
echo " -" >> "$TOC_FILE"
echo " name: '$name'" >> "$TOC_FILE"
echo " href: $filename" >> "$TOC_FILE"
fi
done

6 changes: 6 additions & 0 deletions core/help/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"version": "1.0.0",
"scripts": {
"docs": "./docs-devsite.sh"
}
}
Loading