Skip to content

docs: instruct users to use apt/yum/dnf instead of dpkg/rpm#25700

Merged
hugoShaka merged 15 commits intomasterfrom
hugo/docs-use-apt-instead-of-dpkg
May 9, 2023
Merged

docs: instruct users to use apt/yum/dnf instead of dpkg/rpm#25700
hugoShaka merged 15 commits intomasterfrom
hugo/docs-use-apt-instead-of-dpkg

Conversation

@hugoShaka
Copy link
Copy Markdown
Contributor

@hugoShaka hugoShaka commented May 5, 2023

This PR removes any mention of Teleport installation through raw packages and instructs users to install through package managers.

Using a package manager makes updating easier and is required for the new automatic update feature.

The uninstall documentation still references manual package impression to cover existing setups.

The PR is not mergeable in the current state because we don't support Amazon Linux 2023. I'm waiting to see if the issue #24007 can be addressed before Teleport 13. Else I'll split the Amazon Linux 2023 tabs. Amazon Linux support is out :)

Note for reviewers: if you want to validate the installation instructions, we have a brand-new test package repositories (courtesy of @fheinecke ). e.g.

sudo curl https://apt.releases.development.teleport.dev/gpg -o /usr/share/keyrings/teleport-archive-keyring.asc
source /etc/os-release
echo "deb [signed-by=/usr/share/keyrings/teleport-archive-keyring.asc] https://apt.releases.development.teleport.dev/${ID?} ${VERSION_CODENAME?} stable/v13" \
| sudo tee /etc/apt/sources.list.d/teleport.list > /dev/null

sudo apt-get update
sudo apt-get install teleport

@hugoShaka hugoShaka requested review from stevenGravy and webvictim May 5, 2023 19:12
@hugoShaka hugoShaka marked this pull request as ready for review May 5, 2023 19:12
@hugoShaka hugoShaka force-pushed the hugo/docs-use-apt-instead-of-dpkg branch from 893dec9 to 980101b Compare May 5, 2023 19:12
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
@hugoShaka hugoShaka force-pushed the hugo/docs-use-apt-instead-of-dpkg branch from 4035e99 to 7490c90 Compare May 5, 2023 21:16
@hugoShaka hugoShaka requested a review from webvictim May 5, 2023 21:18
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/installation.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx
Comment thread docs/pages/includes/install-linux.mdx
Comment thread docs/pages/includes/install-linux.mdx
@hugoShaka hugoShaka force-pushed the hugo/docs-use-apt-instead-of-dpkg branch from c6a4461 to f5abcbc Compare May 8, 2023 18:04
Comment thread docs/pages/includes/install-linux.mdx Outdated
Comment thread docs/pages/includes/install-linux.mdx Outdated
@hugoShaka hugoShaka added this pull request to the merge queue May 8, 2023
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks May 8, 2023
@stevenGravy stevenGravy enabled auto-merge May 8, 2023 20:33
@stevenGravy stevenGravy added this pull request to the merge queue May 8, 2023
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks May 8, 2023
@hugoShaka hugoShaka added this pull request to the merge queue May 8, 2023
Comment thread docs/pages/includes/install-linux.mdx Outdated
Use the appropriate commands for your environment to install your package.

<ScopedBlock scope={["cloud"]}>
<Admonition type="note">
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

My first impression when seeing this partial on the dev server is that it's quite a lot of visual information to take in. There are multiple layers of boxes, a code snippet, tabs, a dropdown menu, and a bulleted list. Is there a way to simplify the experience of viewing this partial?

image

Copy link
Copy Markdown
Contributor Author

@hugoShaka hugoShaka May 9, 2023

Choose a reason for hiding this comment

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

I removed the bulleted list and put it on the installation.mdx page instead.

Comment thread docs/pages/installation.mdx Outdated
@ptgott ptgott removed this pull request from the merge queue due to a manual request May 8, 2023
@ptgott
Copy link
Copy Markdown
Contributor

ptgott commented May 8, 2023

@hugoShaka I thought I'd see if you have any thoughts about my comment before we merge this. Thanks!

hugoShaka and others added 2 commits May 9, 2023 09:49
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
@hugoShaka hugoShaka requested review from ptgott and stevenGravy May 9, 2023 14:06
@hugoShaka hugoShaka enabled auto-merge May 9, 2023 14:11
@hugoShaka hugoShaka added this pull request to the merge queue May 9, 2023
Merged via the queue into master with commit 22f0fac May 9, 2023
@hugoShaka hugoShaka deleted the hugo/docs-use-apt-instead-of-dpkg branch May 9, 2023 17:45
@public-teleport-github-review-bot
Copy link
Copy Markdown

@hugoShaka See the table below for backport results.

Branch Result
branch/v13 Create PR

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.

5 participants