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

docs(self-managed): add download link for Docker Compose #4878

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

aabouzaid
Copy link
Member

Description

As we move away from cloning repos to using artifacts, I added the download link for Docker Compose.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@aabouzaid aabouzaid added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Jan 20, 2025
@aabouzaid aabouzaid requested a review from a team January 20, 2025 17:08
@aabouzaid aabouzaid self-assigned this Jan 20, 2025
@aabouzaid
Copy link
Member Author

@camunda/tech-writers, do we have a function that resolves the version of the docs so there is no need to update the links for every release?

Something like this (or so):

https://github.com/camunda/camunda-self-managed/releases/download/docker-compose-<DocsVersion/>/docker-compose-<DocsVersion/>.zip

@aabouzaid aabouzaid marked this pull request as ready for review January 20, 2025 17:10
mesellings
mesellings previously approved these changes Jan 21, 2025
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Approved, great work - just one suggestion for rewording 👍

docs/self-managed/setup/deploy/local/docker-compose.md Outdated Show resolved Hide resolved
@aabouzaid
Copy link
Member Author

@mesellings Thanks for the review 🙌

If there is no function that resolves the version, I can try to create one.

@mesellings
Copy link
Contributor

@mesellings Thanks for the review 🙌

If there is no function that resolves the version, I can try to create one.

@aabouzaid I would liaise with @pepopowitz before spending any time on this 👍

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

Thanks for the follow-up! 🙌

@aabouzaid Re: the release link, there is an ongoing discussion in Distro on how to handle this for C8Run, which has the same issue - I think this could likely be handled there (pointing to latest or similar), as opposed to a docs-side fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

3 participants