Workflows & Recipes

This page collects practical acp2md workflows for customers who already understand the product and now need a repeatable way to apply it in real operational situations.

Controlled retention export

Use this pattern when legal, compliance, or records teams need one exact page captured in a durable format.

acp2md page convert by-id 123456 \
  --include-metadata \
  --output retention/policy-123456.md

Why this workflow matters:

• one page can be retained without exporting a whole space
• the metadata block preserves identifiers and version context
• the result can move into Git, vault storage, or an evidence archive

Runbook export to Git

Use this when an operations or support team wants a runbook under normal source control.

acp2md page convert by-url "https://mycompany.atlassian.net/wiki/spaces/OPS/pages/123456/Runbook" \
  --output docs/runbooks/service-runbook.md \
  --sync

Why this workflow matters:

• the URL form is convenient for operators working from shared browser links
• --sync keeps the checked-in copy aligned with the source page
• the output is already in Markdown and can go straight into repository review workflows

Migration analysis on a difficult page

Use this when the team needs to understand exactly what is inside a heavily formatted page before migration.

acp2md page get by-id 123456 -f atlas_doc_format > analysis/page-123456-adf.json
acp2md page count nodes by-id 123456 > analysis/page-123456-nodes.json
acp2md page count marks by-id 123456 > analysis/page-123456-marks.json

Why this workflow matters:

• ADF retrieval exposes the native page structure
• node and mark counts help estimate layout and formatting complexity
• the team can decide early whether a custom migration rule is needed

Curated source for RAG or search

Use this when you need one authoritative source page in a cleaner, lighter form for downstream AI pipelines.

acp2md page convert by-id 123456 \
  --exclude-marks \
  --embed-images=false \
  --output rag/customer-policy.md

Why this workflow matters:

• plain-text oriented output is easier to chunk and index
• external image references keep the file smaller
• curated page selection produces higher signal than a broad dump

Draft capture before publishing

Use this when a team needs a point-in-time copy of an unpublished draft before an approval or release decision.

acp2md page convert by-id 123456 \
  --get-draft \
  --output archive/draft-123456.md

Why this workflow matters:

• the team captures the pre-publication state of the page
• the export can be reviewed outside Confluence
• change-management or approval records can include the exact draft content

Support-ready diagnostic workflow

Use this when a customer run fails and the issue needs escalation with enough detail for troubleshooting.

acp2md doctor
acp2md support --output support/acp2md-support.zip

Why this workflow matters:

• doctor gives the fastest readiness summary
• the support bundle captures environment, config, diagnostics, and masked variables in one package
• the escalation starts with evidence instead of guesswork

Recommended sequence for customer-facing runs

1. confirm workstation readiness with doctor
2. validate page scope with space list and space pages
3. pick the right page input form: ID, title, or URL
4. decide whether the output is for retention, Git, migration analysis, or AI ingestion
5. choose --sync or --incremental deliberately when writing to files repeatedly