Skip to content

Reorganize container SDK reference for readability and move execution properties to correct section #47738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 6, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 5, 2025

The .NET SDK container reference documentation had become difficult to navigate due to its unorganized, wall-of-text format. This PR reorganizes the content into logical categories and addresses feedback to correctly categorize execution-related properties.

Changes Made

Reorganized properties into 4 main categories:

  1. Flags that control the base image - Properties like ContainerBaseImage, ContainerFamily, and ContainerRuntimeIdentifier(s) that determine which base image is used
  2. Flags that control generated-image-independent metadata - Properties like ContainerImageTag, ContainerImageFormat, ContainerLabel, and ContainerRepository that configure image metadata regardless of target runtime
  3. Flags that control execution metadata - Runtime-specific properties including ContainerAppCommand, ContainerAppCommandArgs, ContainerAppCommandInstruction, ContainerDefaultArgs, ContainerEnvironmentVariable, ContainerPort, ContainerUser, ContainerWorkingDirectory, and ContainerPublishInParallel that control how containers run and are likely to change across OS/platform combinations
  4. Flags that control the destination of generated images - Properties like ContainerRegistry, ContainerArchiveOutputPath, and LocalRegistry that control where images are stored or published

Additional improvements:

  • Moved execution-related properties to the correct section based on feedback that these properties control container runtime behavior and vary across different OS/platform combinations
  • Alphabetized properties within each category for easy lookup
  • Added clear section headers explaining the purpose of each category
  • Removed duplicate content that resulted from the original organization
  • Maintained all existing content, examples, code snippets, and cross-references
  • Reduced file length from 937 to 498 lines while preserving all information
  • Ensured markdown linting passes with 0 errors

The document now provides a much more navigable reference that helps developers quickly find the properties they need based on what aspect of containerization they want to control, with proper categorization of execution-related properties.

Fixes #45910.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/core/containers/publish-configuration.md docs/core/containers/publish-configuration

Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Reorganize container SDK reference for readabilty Reorganize container SDK reference for readability Aug 5, 2025
@Copilot Copilot AI requested a review from gewarren August 5, 2025 20:57
Copilot finished work on behalf of gewarren August 5, 2025 20:57
@gewarren gewarren marked this pull request as ready for review August 5, 2025 23:07
@gewarren gewarren requested a review from a team as a code owner August 5, 2025 23:07
@gewarren gewarren requested a review from baronfel August 5, 2025 23:08
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM as well.

Let's :shipit:

@baronfel
Copy link
Member

baronfel commented Aug 6, 2025

I have one organizational comment, but otherwise this looks great!

- Moved ContainerAppCommand, ContainerAppCommandArgs, ContainerAppCommandInstruction, ContainerDefaultArgs, ContainerEnvironmentVariable, ContainerPort, ContainerUser, and ContainerWorkingDirectory from "generated-image-independent metadata" to "execution metadata" section
- These properties control how the container runs and can vary across OS/platform combinations
- Maintained alphabetical ordering within each section
- Updated section headers and property lists accordingly
- All internal links and documentation preserved

Co-authored-by: baronfel <573979+baronfel@users.noreply.github.com>
@Copilot Copilot AI changed the title Reorganize container SDK reference for readability Reorganize container SDK reference for readability and move execution properties to correct section Aug 6, 2025
@Copilot Copilot AI requested a review from baronfel August 6, 2025 14:26
Copilot finished work on behalf of baronfel August 6, 2025 14:26
@gewarren gewarren merged commit 1a56ab1 into main Aug 6, 2025
11 checks passed
@gewarren gewarren deleted the copilot/fix-45910 branch August 6, 2025 16:30
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.

Reorganize container SDK reference for readabilty
4 participants