From cd431d80c8688ccb7eddf0b02ed95793c2d2fdeb Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 3 Feb 2023 15:49:21 -0500 Subject: [PATCH] Add demo docs (#2246) --- .gitmodules | 3 +++ content-modules/opentelemetry-demo | 1 + hugo.yaml | 4 ++++ scripts/adjust-spec-pages.pl | 9 +++++++++ scripts/cp-spec-pages.sh | 22 +++++++++++++++++++++- 5 files changed, 38 insertions(+), 1 deletion(-) create mode 160000 content-modules/opentelemetry-demo diff --git a/.gitmodules b/.gitmodules index b5d589c3a714..c5680b8dc1c9 100644 --- a/.gitmodules +++ b/.gitmodules @@ -8,3 +8,6 @@ [submodule "content-modules/opentelemetry-specification"] path = content-modules/opentelemetry-specification url = https://github.com/open-telemetry/opentelemetry-specification.git +[submodule "content-modules/opentelemetry-demo"] + path = content-modules/opentelemetry-demo + url = https://github.com/open-telemetry/opentelemetry-demo diff --git a/content-modules/opentelemetry-demo b/content-modules/opentelemetry-demo new file mode 160000 index 000000000000..4b8bb4554b88 --- /dev/null +++ b/content-modules/opentelemetry-demo @@ -0,0 +1 @@ +Subproject commit 4b8bb4554b8888c712349d26679cca109f4c575e diff --git a/hugo.yaml b/hugo.yaml index fe7fc4a8f74b..9f8c9716ce9b 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -54,6 +54,8 @@ params: github_repo: https://github.com/open-telemetry/opentelemetry.io github_branch: main gcs_engine_id: bde3d634eca9cd335 + # The following mermaid config can be dropped after we update Docsy to v0.6.0 or later + mermaid: { enable: true } ## Social media image path, such as Open Graph's og:image # @@ -169,6 +171,8 @@ services: module: mounts: + - source: tmp/demo/docs + target: content/docs/demo - source: tmp/specification target: content/docs/reference/specification - source: content/en diff --git a/scripts/adjust-spec-pages.pl b/scripts/adjust-spec-pages.pl index 7dadcf17cf8e..7b1b8e73e4b8 100755 --- a/scripts/adjust-spec-pages.pl +++ b/scripts/adjust-spec-pages.pl @@ -72,6 +72,8 @@ () next; } + # SPECIFICATION custom processing + s|\(https://github.com/open-telemetry/opentelemetry-specification\)|(/docs/reference/specification/)|; s|\.\./semantic_conventions/README.md|$semConvRef| if $ARGV =~ /overview/; @@ -105,5 +107,12 @@ () # Make website-local page references local: s|https://opentelemetry.io/|/|g; + # DEMO DOCS custom processing + + s|\./(services/\w+)\.md|$1/|g if $ARGV =~ /demo.docs._index/; + s/#demo-screenshots/./; + s|(/vendors/)|/ecosystem$1|g; + s|(\.\.\/)+(src/)|https://github.com/open-telemetry/opentelemetry-demo/blob/main/$2|g if $ARGV =~ /demo.docs/; + print; } diff --git a/scripts/cp-spec-pages.sh b/scripts/cp-spec-pages.sh index df01ebb2f710..6e560454e32e 100755 --- a/scripts/cp-spec-pages.sh +++ b/scripts/cp-spec-pages.sh @@ -1,8 +1,10 @@ #!/usr/bin/env bash BASE_DIR=$(dirname $0) +DEST_BASE=tmp + SPEC=content-modules/opentelemetry-specification/specification -DEST=tmp/specification +DEST=$DEST_BASE/specification rm -Rf $DEST mkdir -p $DEST @@ -16,3 +18,21 @@ FILES=$(find $DEST -name "*.md") $BASE_DIR/adjust-spec-pages.pl $FILES echo "Specification pages copied and processed." + +# Demo docs + +SRC=content-modules/opentelemetry-demo/docs +DEST=$DEST_BASE/demo/docs + +rm -Rf $DEST +mkdir -p $DEST +cp -R $SRC/* $DEST/ + +find $DEST/ -name "README.md" -exec sh -c 'f="{}"; mv -- "$f" "${f%README.md}_index.md"' \; + +# To exclude a file use, e.g.: -not -path '*/some-path/_index.md' +FILES=$(find $DEST -name "*.md") + +$BASE_DIR/adjust-spec-pages.pl $FILES + +echo "Demo doc pages copied and processed."