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.

Sign up for GitHub

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

Add OpenSSH requirements to 02-install.md #9228

Merged
merged 2 commits into from
Sep 27, 2024
Merged

Add OpenSSH requirements to 02-install.md #9228

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e55b082
Add OpenSSH requirements to 02-install.md
codyfishman Sep 18, 2024
4872976
Copy edits, add openssh to required packages, remove recommended pack…
rachelwhitton Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions source/content/terminus/02-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ Terminus does not work with the following platforms:

### Recommended Packages

- [OpenSSH 7.8](https://github.com/PowerShell/Win32-OpenSSH/wiki/) or later
- You can check your OpenSSH version by running `ssh -V` from a terminal application.
- This is required package for executing nested Drush or WP-CLI commands.
Copy link
Member

@rachelwhitton rachelwhitton Sep 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Since the copy says this package is required, it should be moved from "Recommended Packages" to the above section, "Required Packages". nvm it makes sense here after a second read

Should this also be added to the projects README?

@kporras07 @stovak can you review and weigh in?

Copy link
Contributor

Choose a reason for hiding this comment

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

I like the idea of calling openssh out here (and maybe even moving it to required); I'm not sure I like linking it to PowerShell Win32-OpenSSH but I don't know of a better link. Would it make sense to NOT link anything here and allow customers to get the right package based on their OS?

Copy link
Contributor

Choose a reason for hiding this comment

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

100% agreement on also getting it to project's README. I can create a quick PR once we figure out how we want to do it here

Copy link
Member

Choose a reason for hiding this comment

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

@kporras07 I reviewed this again with @jazzsequence during docs coworking this morning, we decided to remove the link entirely (we don't link out to PHP in that same list so I think it's fine without), move OpenSSH up to the required packages section, and remove the recommended packages section. Can you do another review when convenient?

- [Drush](https://www.drush.org/12.x/install/). This is useful if you need to run Drush commands that are incompatible with Terminus.
- [WP-CLI](http://wp-cli.org/). This is useful if you need to run WP-CLI commands that are incompatible with Terminus.

Expand Down
Loading