Skip to content
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

Added supported Compose spec properties #153

Merged
merged 30 commits into from
Jan 16, 2025
Merged

Conversation

commit111
Copy link
Collaborator

@commit111 commit111 commented Dec 23, 2024

Fixes #134

Updated the Compose page to show what top-level and service-level properties of Compose specification are supported by Defang

Copy link
Member

@jordanstephens jordanstephens left a comment

Choose a reason for hiding this comment

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

Great progress on this @commit111 !

docs/concepts/compose-support.md Outdated Show resolved Hide resolved
docs/concepts/compose-support.md Outdated Show resolved Hide resolved
docs/concepts/compose-support.md Outdated Show resolved Hide resolved
docs/concepts/compose-support.md Outdated Show resolved Hide resolved
docs/concepts/compose-support.md Outdated Show resolved Hide resolved
docs/concepts/compose-support.md Outdated Show resolved Hide resolved
@commit111 commit111 marked this pull request as ready for review January 8, 2025 21:35
@commit111 commit111 changed the title Add page for compose support Update compose docs to show supported properties Jan 8, 2025
Copy link
Member

@jordanstephens jordanstephens left a comment

Choose a reason for hiding this comment

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

Added some links and tried to fill things out a bit further.

docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Show resolved Hide resolved
docs/concepts/compose.md Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Show resolved Hide resolved
commit111 and others added 2 commits January 8, 2025 15:52
@commit111 commit111 changed the title Update compose docs to show supported properties Add supported Compose spec properties Jan 13, 2025
@commit111 commit111 changed the title Add supported Compose spec properties Added supported Compose spec properties Jan 13, 2025
Copy link
Member

@lionello lionello left a comment

Choose a reason for hiding this comment

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

Just some minor feedback

docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
```

:::info
Read more about configuration in the [Configuration page](./configuration.md).
After you set sensitive environment variables as blank or `null` values in the `compose.yaml` file, you can securely set their actual value in the Defang CLI. See our [Configuration page](/docs/concepts/configuration) for more.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
After you set sensitive environment variables as blank or `null` values in the `compose.yaml` file, you can securely set their actual value in the Defang CLI. See our [Configuration page](/docs/concepts/configuration) for more.
After you set sensitive environment variables as blank or `null` values in the `compose.yaml` file, you can securely set their actual value with the Defang CLI. See our [Configuration page](/docs/concepts/configuration) for more.

docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
docs/concepts/compose.md Outdated Show resolved Hide resolved
@commit111 commit111 merged commit fead321 into main Jan 16, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document Our Relationship to the Compose Spec
3 participants