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

[v9] Make the Installation guide more usable #12369

Merged
merged 1 commit into from
May 11, 2022

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented May 2, 2022

Backports #12282

  • Make the Installation guide more usable

See #11841

  • Combined two H2s related to OS support

  • Fleshed out the Docker section: The current instructions only show a
    "docker pull" command. Since users will likely be using other methods
    to run containers from our images (e.g., a docker-compose config or
    "docker run", which pulls the image automatically), I added more
    context around the available Docker images.

  • Updated the latest Docker image version

  • Fleshed out the Helm section: Added updated information and more
    detail about our charts.

  • Cleaned up the macOS installation instructions. Use updated installer
    links. Combine the "Installer" and "Terminal" tabs, since both use our
    installer endpoints. Add instructions for checking Teleport versions to
    the Homebrew tab.

  • Move comments in the Checksums section above commands so it is
    possible to copy the code snippet and run the commands from a terminal.

  • Mention tbot

  • Update PowerShell installation instructions. As written, they did
    not work for me when I tested them.

  • Respond to PR feedback

@ptgott ptgott force-pushed the paul.gottschling/12282-bp-v9 branch from 58d6ab7 to 2dda9b9 Compare May 4, 2022 20:50
@ptgott ptgott enabled auto-merge (squash) May 11, 2022 20:22
Backports #12282

* Make the Installation guide more usable

See #11841

- Combined two H2s related to OS support

- Fleshed out the Docker section: The current instructions only show a
  "docker pull" command. Since users will likely be using other methods
  to run containers from our images (e.g., a docker-compose config or
  "docker run", which pulls the image automatically), I added more
  context around the available Docker images.

- Updated the latest Docker image version

- Fleshed out the Helm section: Added updated information and more
  detail about our charts.

- Cleaned up the macOS installation instructions. Use updated installer
  links. Combine the "Installer" and "Terminal" tabs, since both use our
  installer endpoints. Add instructions for checking Teleport versions to
  the Homebrew tab.

- Move comments in the Checksums section above commands so it is
  possible to copy the code snippet and run the commands from a terminal.

- Mention tbot

- Update PowerShell installation instructions. As written, they did
  not work for me when I tested them.

* Respond to PR feedback
@ptgott ptgott force-pushed the paul.gottschling/12282-bp-v9 branch from 2dda9b9 to 645745b Compare May 11, 2022 20:22
@ptgott ptgott merged commit b76add8 into branch/v9 May 11, 2022
@webvictim webvictim mentioned this pull request Jun 8, 2022
@ptgott ptgott deleted the paul.gottschling/12282-bp-v9 branch April 5, 2023 18:17
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.

3 participants