Skip to content

Improve the connection instructions landing page for VS Code (SSHD)#590

Merged
rgrunber merged 2 commits into
che-incubator:mainfrom
rgrunber:landing-instructions
Nov 7, 2025
Merged

Improve the connection instructions landing page for VS Code (SSHD)#590
rgrunber merged 2 commits into
che-incubator:mainfrom
rgrunber:landing-instructions

Conversation

@rgrunber

@rgrunber rgrunber commented Oct 24, 2025

Copy link
Copy Markdown
Collaborator

Fixes https://issues.redhat.com/browse/CRW-9547

  • Add CSS styling for code blocks, as well as a copy feature
  • Specify the namespace for oc port-forward (-n)
  • Move private key permission warning to listing of the key
  • Move instructions about "VS Code" SSH extension
  • Make it more clear the example path to private key should be replaced
  • Link to the "Command Line Tools" page and the "Token Request" page
  • Adapt paths based on operating system (windows, linux-based)
  • Ensure private key code block is displayed with newline prior to EOF

Note: the containers that authorized the given keys have been destroyed

Before
Screenshot From 2025-10-23 11-59-58

After
Screenshot From 2025-10-24 12-22-22

This PR should be merged with eclipse-che/che-operator#2062 .

Signed-off-by: Roland Grunberg <[email protected]>
@github-actions

github-actions Bot commented Oct 24, 2025

Copy link
Copy Markdown
Contributor

Click here to review and test in web IDE: Contribute

@github-actions

Copy link
Copy Markdown
Contributor

Comment thread build/scripts/code-sshd-page/server.js Outdated
- Add CSS styling for code blocks, as well as a copy feature
- Specify the namespace for oc port-forward (-n)
- Move private key permission warning to listing of the key
- Move instructions about "VS Code" SSH extension
- Make it more clear the example path to private key should be replaced
- Link to the "Command Line Tools" page and the "Token Request" page
- Adapt paths based on operating system (windows, linux-based)
- Ensure private key code block is displayed with newline prior to EOF

Signed-off-by: Roland Grunberg <[email protected]>
@rgrunber rgrunber force-pushed the landing-instructions branch from ff8788f to 822ebcb Compare October 28, 2025 15:41
@github-actions

Copy link
Copy Markdown
Contributor

@azatsarynnyy azatsarynnyy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

To test the PR, I:

Got the following errors:
Image

I tried it with a few different samples.

@rgrunber

rgrunber commented Oct 31, 2025

Copy link
Copy Markdown
Collaborator Author

Thanks for trying this! The pull request job doesn't currently deploy the image. It only happens on push :

docker buildx build \
--platform linux/amd64 \
--progress=plain \
-f build/dockerfiles/dev.Dockerfile \
-t che-dev .
, since the Dockerfile is at https://github.com/che-incubator/che-code/blob/main/build/dockerfiles/dev.sshd.Dockerfile . I've tested by deploying to https://quay.io/repository/rgrunber/che-code-sshd?tab=tags .

Also, the following change will be needed into the editor definition :

-        - "nohup /entrypoint.sh & nohup /sshd.start & nohup node /opt/www/server.js & tail -f /dev/null"
+        - "nohup /entrypoint.sh & nohup /sshd.start & pushd /opt/www/ && nohup node /opt/www/server.js & tail -f /dev/null"

@azatsarynnyy azatsarynnyy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @rgrunber for noticing this. I used the wrong image.

It works as expected, taking into account your comment above

Image

@rgrunber rgrunber merged commit fad2c31 into che-incubator:main Nov 7, 2025
12 of 13 checks passed
@rgrunber rgrunber deleted the landing-instructions branch November 7, 2025 13:46
@rgrunber rgrunber restored the landing-instructions branch November 12, 2025 16:07
@rgrunber rgrunber deleted the landing-instructions branch November 12, 2025 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants