Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
85a9bb1
attempt running mkdocs
chgray Aug 21, 2025
871b316
attempt running mkdocs
chgray Aug 21, 2025
3db900f
attempt running mkdocs
chgray Aug 21, 2025
e19c206
fix broken mkdocs link (that was caught due to strict compilation)
chgray Aug 21, 2025
cee8288
fix broken mkdocs link (that was caught due to strict compilation)
chgray Aug 21, 2025
2f22405
add a rollup job, that we can use later to more easily stop publishin…
chgray Aug 21, 2025
19d2f0d
lint
chgray Aug 21, 2025
626ed3b
lint
chgray Aug 21, 2025
b0e3894
lint
chgray Aug 21, 2025
753c4e3
lint
chgray Aug 21, 2025
5b81e00
lint
chgray Aug 21, 2025
6cb73e9
lint
chgray Aug 21, 2025
82744d0
lint
chgray Aug 21, 2025
14f5df6
lint
chgray Aug 21, 2025
1ccce52
lint
chgray Aug 21, 2025
c6b0be2
lint
chgray Aug 21, 2025
2fbf415
lint
chgray Aug 21, 2025
aa27cd6
lint
chgray Aug 21, 2025
c0feb23
lint
chgray Aug 21, 2025
c367744
lint
chgray Aug 21, 2025
f458afa
lint
chgray Aug 21, 2025
045d809
lint
chgray Aug 21, 2025
c6b5516
lint
chgray Aug 21, 2025
b3ec1d7
lint
chgray Aug 21, 2025
a36ffd1
lint
chgray Aug 21, 2025
a555b16
lint
chgray Aug 21, 2025
4e16199
lint
chgray Aug 21, 2025
6b1e2e2
remove the CDocs markdown render
chgray Aug 21, 2025
a5af1fb
Merge commit '6b1e2e2a5a72423f7f5d99c7eb2262a9df9d204b' into user/chg…
chgray Aug 21, 2025
f1473a5
remove publishing mkdocs
chgray Aug 21, 2025
102f794
remove publishing mkdocs
chgray Aug 21, 2025
70d5c8c
remove publishing mkdocs
chgray Aug 21, 2025
1617160
remove publishing mkdocs
chgray Aug 21, 2025
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
2 changes: 1 addition & 1 deletion docs/docs/Rude_Q_and_A.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ OpenTelemetry's standard protocols and specifications.

Where there could be some struggles; and something to monitor, is that Dynamic
Telemetry makes use of triggering
[Actions](./Architecture.Action.Explanation.document.md). These Actions benefit
[Actions](./Architecture.Actions.Overview.document.md). These Actions benefit
from ability to decode and understand logging.

Where Dynamic Telemetry may find itself
Expand Down
65 changes: 1 addition & 64 deletions tools/PreCheckinUpdate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,10 @@ set -e
SCRIPT_PATH=$(dirname "$(realpath "${BASH_SOURCE[0]}")")
echo "Script path: $SCRIPT_PATH"

export CDOCS_MARKDOWN_RENDER_PATH=$(realpath ${SCRIPT_PATH}/../../CDocs)
export DT_BOUND_DIR=$(realpath ${SCRIPT_PATH}/../docs/bound_docs)
export DT_DOCS_DIR=$(realpath ${SCRIPT_PATH}/../docs/docs)
export DT_ORIG_MEDIA_DIR=$(realpath ${SCRIPT_PATH}/../docs/orig_media)

# Check for required environment variable
if [ ! -d "${CDOCS_MARKDOWN_RENDER_PATH}" ]; then
git clone --branch user/chgray/update_ubuntu http://github.com/chgray/CDocs ${CDOCS_MARKDOWN_RENDER_PATH}
fi

export PATH=${CDOCS_MARKDOWN_RENDER_PATH}/tools/CDocsMarkdownCommentRender/bin/Debug/net8.0:$PATH$
export | grep CDOCS
export | grep DT

# Verify the path exists and contains the required binary
if [ ! -f "${CDOCS_MARKDOWN_RENDER_PATH}/tools/CDocsMarkdownCommentRender/bin/Debug/net8.0/CDocsMarkdownCommentRender" ]; then
echo "ERROR: CDocsMarkdownCommentRender binary not found in CDOCS_MARKDOWN_RENDER_PATH: ${CDOCS_MARKDOWN_RENDER_PATH}"
dotnet build ${CDOCS_MARKDOWN_RENDER_PATH}/tools/CDocsMarkdownCommentRender
fi

if [ ! -f "${CDOCS_MARKDOWN_RENDER_PATH}/tools/CDocsMarkdownCommentRender/bin/Debug/net8.0/CDocsMarkdownCommentRender" ]; then
echo "ERROR: CDocsMarkdownCommentRender binary not found in CDOCS_MARKDOWN_RENDER_PATH: ${CDOCS_MARKDOWN_RENDER_PATH}"
exit 1
fi

if [ -z "${DT_BOUND_DIR}" ]; then
echo "ERROR: DT_BOUND_DIR environment variable must be set"
Expand All @@ -54,55 +34,13 @@ if [ ! -d "${DT_ORIG_MEDIA_DIR}" ]; then
mkdir ${DT_ORIG_MEDIA_DIR}
fi

#
# See if the pandoc image exists; if not, pull it - we're inspecting
# the location of the file, and not calling the executable, because
# of struggles with WSL2, where Windows<-->Linux interop is indicating
# the presence of Docker
#
echo "Determining if we're using docker or podman, docker preferred"
if [ -f "/usr/bin/docker" ]; then
echo "Using Docker."
container_tool="docker"
elif [ -f "/usr/bin/podman" ]; &> /dev/null; then
echo "Using podman"
container_tool="podman"
else
echo "Either docker or podman are required"
exit 1
fi

set +e
${container_tool} image exists docker.io/chgray123/chgray_repro:pandoc

if [ $? -ne 0 ]; then
set -e
echo "Pulling pandoc image..."
${container_tool} image pull docker.io/chgray123/chgray_repro:pandoc
fi

set +e
${container_tool} image exists chgray123/chgray_repro:cdocs.mermaid

if [ $? -ne 0 ]; then
set -e
echo "Pulling cdocs.mermaid image..."
${container_tool} image pull docker.io/chgray123/chgray_repro:cdocs.mermaid
fi
set -e

# Start in our script directory
cd ${SCRIPT_PATH}

#
# Setup the Python environment
#
# if [ ! -d "/mkdocs_python" ]; then
# echo "ERROR: /mkdocs_python not found"
# exit 1
# fi
# source /mkdocs_python/bin/activate

#
# READ-WRITE Update Status Page, Probe Images, etc
#
Expand All @@ -121,7 +59,6 @@ gnuplot ./_BuildProbeSpider.gnuplot

cd ../docs/docs


#
# READ-ONLY: Do Binding and create content in docx/pdf/epub
#
Expand Down Expand Up @@ -170,7 +107,7 @@ fi
echo " INPUT_FILE : $inputFile"
echo "DT_BOUND_DIR : $DT_BOUND_DIR"

args="--toc --toc-depth 4 -N --filter CDocsMarkdownCommentRender"
args="--toc --toc-depth 4 -N"

export CDOCS_FILTER=1
pandoc $inputFile -o "$DT_BOUND_DIR/epub_$fileName.a5.epub" --epub-cover-image=../orig_media/DynamicTelemetry.CoPilot.Image.png -V papersize=a5 $args
Expand Down
1 change: 0 additions & 1 deletion tools/buildAsBook/Dockerfile.pandoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ ENV PATH=$PATH:$DOTNET_ROOT/tools
# RUN dotnet tool install powershell --global

RUN apt-get install -y -q git
ENV PATH=$PATH:/Source/CDocs/tools/CDocsMarkdownCommentRender/bin/Debug/net8.0
RUN apt-get update
RUN apt-get install -y -q podman
RUN apt-get install -y -q tmux
Expand Down
2 changes: 1 addition & 1 deletion tools/buildAsBook/bind.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ def process_markdown_files(docs_dir, bound_docs_dir, mkdocs_content):

# Convert using pandoc
dest_file = os.path.join(bound_docs_dir, dest_leaf)
cmd = f'pandoc -i "{source_file}" -o "{dest_file}" --filter CDocsMarkdownCommentRender --lua-filter=../../tools/newpage-to-openxml.lua'
cmd = f'pandoc -i "{source_file}" -o "{dest_file}" --lua-filter=../../tools/newpage-to-openxml.lua'

print("")
print(f"# Converting {source_file} ==> {dest_leaf}")
Expand Down