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: Update docker installation topic #12770

Merged
merged 7 commits into from
May 2, 2024
Merged

docs: Update docker installation topic #12770

merged 7 commits into from
May 2, 2024

Conversation

JStickler
Copy link
Contributor

@JStickler JStickler commented Apr 23, 2024

Which issue(s) this PR fixes:
Fixes #12155

Updated the docker installation topic before I realized that the issue was for docker install for Promtail. So two updates for the price of one!
Splits out the commands into separate steps for downloading and running the files. Adds some validation steps (for Linux).

@JStickler JStickler added type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories backport release-3.0.x labels Apr 23, 2024
@JStickler JStickler requested a review from a team as a code owner April 23, 2024 21:06
@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

1 similar comment
@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

@JStickler JStickler changed the title docs: Update docker installation topic [WIP] docs: Update docker installation topic Apr 23, 2024
@JStickler JStickler changed the title [WIP] docs: Update docker installation topic docs: Update docker installation topic Apr 24, 2024
Copy link
Collaborator

@trevorwhitney trevorwhitney left a comment

Choose a reason for hiding this comment

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

Looks good, one small nit/question


## Prerequisites

- [Docker](https://docs.docker.com/install)
- [Docker Compose](https://docs.docker.com/compose/install) (optional, only needed for the Docker Compose install method)

## Install with Docker
## Install with Docker on Linux
Copy link
Collaborator

Choose a reason for hiding this comment

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

What's specific about Linux here? Will these instructions not work on Mac/BSD/etc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question, I was trying to differentiate between this and the Windows installation. Any suggestions for a better heading?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, that was already the heading....

Copy link
Member

Choose a reason for hiding this comment

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

The heading was previously Install with Docker not Install with Docker on Linux unless I'm missing something?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

InstallDocker
Previous heading arrangement ^

Copy link
Member

Choose a reason for hiding this comment

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

Oh yeah, the bold bit after. Makes sense to make that part of the heading instead.

Probably worth visiting if the instructions are suitable for other similar platforms later

@JStickler JStickler merged commit afbeedc into main May 2, 2024
60 checks passed
@JStickler JStickler deleted the GH_12155 branch May 2, 2024 15:24
grafanabot pushed a commit that referenced this pull request May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x size/L type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs feedback: /docs/sources/send-data/promtail/installation.md
5 participants