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

[divine7022]

5. Most Docker info is currently in Dev-Intro

Description:

The Docker documentation is currently located in 94_docker but contains developer/deployment-focused content that should be part of the Developer Guide. This creates navigation confusion since Docker infrastructure docs are mixed with user facing content like PEcAn standards, meteorology drivers, and model descriptions under "Topical Pages."

Current issue:

• Docker documentation (~ 10 files) is in 94_docker
• Developer Guide is in 05_developer_workflows
• These two are logically related but physically separated
• The rendered documentation shows Docker as a chapter under "Topical Pages" rather than "Developer Guide"

Current Docker documentation lives under:

book_source/03_topical_pages/94_docker/

with the following files:
00_docker_index.Rmd --> Docker chapter index
01_introduction.Rmd --> What is Docker, docker-compose
02_quickstart.Rmd --> Quick-start installation
03_architecture.Rmd --> PEcAn Docker architecture
04_models.Rmd --> Adding models to Docker
05_building_images.Rmd --> Building/modifying images
06_troubleshooting.Rmd --> Docker troubleshooting
07_migrate.Rmd --> VM to Docker migration
08_pecan_api.Rmd --> PEcAn API in Docker context
09_rabbitmq.Rmd --> RabbitMQ configuration

Developer-focused documentation currently lives under:

book_source/02_demos_tutorials_workflows/05_developer_workflows/

including:
00_developer_guide.Rmd --> Developer guide index
01_update_pecan_code.Rmd--> Updating PEcAn code
04-testing.Rmd --> Testing documentation
05-compile-pecan.Rmd --> Compiling PEcAn
06-directory-structure.Rmd --> Directory structure
02_git/ ---> Git documentation
03_coding_practices/ --> Coding practices

Files that reference Docker anchors (will need link updates):

• 01_install_pecan.Rmd - links to #docker-intro, #docker-index
• 00_installation_index.Rmd - links to #docker-index
• Internal Docker file cross-references (e.g. 07_migrate.Rmd links to #docker-intro, #docker-quickstart)

Key links:
Current (Topical Pages):

• https://pecanproject.github.io/pecan-documentation/develop/docker-index.html
• https://pecanproject.github.io/pecan-documentation/develop/docker-intro.html
• https://pecanproject.github.io/pecan-documentation/develop/docker-quickstart.html

Tasks:

• Move 94_docker contents to 05_developer_workflows (as a new 04_docker/ subdirectory or similar)
• Adjust heading levels if needed (Docker files use # for chapter, ## for sections)
• Update internal cross-references within moved Docker files
• Update external references in:
  - 01_install_pecan.Rmd
  - 00_installation_index.Rmd
• Build book locally to verify no broken links
• Remove empty 94_docker/ directory from Topical Pages

Acceptance criteria:

• Docker documentation appears under Developer Guide in rendered book TOC
• All internal links text work correctly
• Book builds without errors

Additional consolidation of developer-focused documentation will be filed in follow-up issues once Docker content is relocated.

[man080107]

Hey @divine7022 i would like to work on this issue please aasign it to me thanks !!

[shreyannandanwar]

Hi, @divine7022 This issue is currently assigned, but I don’t see an active PR yet. If it’s okay, I’d like to start working on this and submit a PR. Please let me know if that works or if there’s any coordination needed.

[Thomas-Sedhom]

Hi @divine7022, if this issue is still open, I’d be happy to work on it.