Skip to content

"Move Docker documentation under Developer Guide"#3747

Closed
man080107 wants to merge 2 commits intoPecanProject:developfrom
man080107:issue-3743-docker-intro
Closed

"Move Docker documentation under Developer Guide"#3747
man080107 wants to merge 2 commits intoPecanProject:developfrom
man080107:issue-3743-docker-intro

Conversation

@man080107
Copy link
Copy Markdown
Contributor

@man080107 man080107 commented Jan 4, 2026

Description

This pull request reorganizes the Docker-related documentation by moving it from the "Topical Pages" section to the "Developer Guide" section of the book. The content itself is unchanged; only the structure and links have been updated to improve navigation and clarity.

Motivation and Context

Docker documentation is primarily developer- and deployment-focused, but it was previously listed under user-facing "Topical Pages," which caused confusion when browsing the documentation. This change places Docker documentation alongside other developer workflows, making the documentation structure more intuitive.

This PR addresses issue #3746.

Review Time Estimate

  • Immediately
  • Within one week
  • When possible

Types of changes

  • Bug fix
  • New feature
  • Breaking change

Checklist:

  • My change requires a change to the documentation.
  • My name is in the list of CITATION.cff
  • 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 CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@mdietze mdietze enabled auto-merge January 4, 2026 15:56
@mdietze
Copy link
Copy Markdown
Member

mdietze commented Jan 4, 2026

Error in `knitr::include_graphics()`:
! Cannot find the file(s): "book_source/02_demos_tutorials_workflows/05_developer_workflows/04_docker/pecan-docker.png"
Backtrace:
    ▆
 1. └─knitr::include_graphics("book_source/02_demos_tutorials_workflows/05_developer_workflows/04_docker/pecan-docker.png")

Quitting from _main.Rmd:4373-4375 [unnamed-chunk-46]
Please delete _main.Rmd after you finish debugging the error.

@man080107
Copy link
Copy Markdown
Contributor Author

Thanks @mdietze for pointing out the issue! I’ve fixed it and included the solution in PR #3748. Could you please take a look when you have time? Thanks!

@infotroph infotroph mentioned this pull request Jan 4, 2026
14 tasks
man080107 added a commit to man080107/pecan that referenced this pull request Jan 5, 2026
@man080107
Copy link
Copy Markdown
Contributor Author

I worked on the same issue but a beginner mistakenly opened a new PR #3749 instead of adding the fix here. Apologies for that

@mdietze
Copy link
Copy Markdown
Member

mdietze commented Jan 5, 2026

superseded by #3749

@mdietze mdietze closed this Jan 5, 2026
auto-merge was automatically disabled January 5, 2026 13:57

Pull request was closed

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.

2 participants