Skip to content

Consolidate Docker documentation under Developer Guide (#3743) - #4056

Open
ANAMASGARD wants to merge 1 commit into
PecanProject:developfrom
ANAMASGARD:GH-3743-move-docker-docs
Open

Consolidate Docker documentation under Developer Guide (#3743)#4056
ANAMASGARD wants to merge 1 commit into
PecanProject:developfrom
ANAMASGARD:GH-3743-move-docker-docs

Conversation

@ANAMASGARD

Copy link
Copy Markdown
Contributor

Description

Completes the Docker documentation consolidation for #3743 by fixing broken cross-references introduced when Docker docs were moved from 94_docker into the Developer Guide.

Changes:

  • Replace broken path-based links with anchor-based same-book links (#docker-index, #docker-intro, etc.)
  • Add Docker to the Developer Guide index
  • Fix malformed Markdown links and corrupted migration text
  • Repair missing anchor targets (#docker-local-devel, #docker-troubleshooting)
  • Add missing Docker index entries for API and RabbitMQ

Motivation and Context

Docker docs were moved under Developer Guide, but several links still pointed to old paths like developer-workflows/docker-index.html and 04_docker/*.html. This PR fixes navigation so Docker appears correctly under Developer Guide and internal links resolve reliably.

Fixes #3743

Review Time Estimate

  • Within one week

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • My change requires a change to the documentation.
  • I agree that PEcAn Project may distribute my contribution under any or all of
    • the same license as the existing code,
    • and/or the BSD 3-clause license.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.

Test plan

  • make -C book_source clean && make book completed without errors
  • Docker appears under Developer Guide in rendered TOC (not Topical Pages)
  • Links from Install PEcAn and Installation details pages work
  • Docker chapter internal navigation works
  • Troubleshooting page Docker link resolves to #docker-troubleshooting
  • Architecture section image renders correctly

Verification

image

…t#3743)

Fix broken cross-references after the move from 94_docker using
anchor-based same-book links, add Docker to the Developer Guide index,
and repair malformed links and missing anchor targets.

Signed-off-by: Gaurav Chaudhary <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consolidate developer's guide: Move Docker Documentation from Topical Pages

1 participant