Skip to content

Documentation for Sharable Ports and Protocol selection #13070

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

Closed
5 tasks
Tracked by #11486
stirby opened this issue Apr 24, 2024 · 1 comment
Closed
5 tasks
Tracked by #11486

Documentation for Sharable Ports and Protocol selection #13070

stirby opened this issue Apr 24, 2024 · 1 comment
Labels
docs Area: coder.com/docs

Comments

@stirby
Copy link
Collaborator

stirby commented Apr 24, 2024

Preface

We don't have much existing documentation around controlling workspace ports.

Since the Sharable Ports feature introduced two new axes of port manipulation, I think it warrants a new page to discuss both.

What to cover

  • Screenshot of the new ports UI with various shared port configuration
  • How to share a port at different levels
  • Explanation of admin-level controls (maximum port sharing level)
  • How sharable ports interacts with coder_apps
  • Protocol control

Location/Design

Option 1

We append to the port forwarding page. I hesitate here because there's already so much content there.

Option 2

We create a new page under Networking for controlling workspace ports/services.

Option 3

We break the Workspaces page into subcategories:

  • index.md: Creating, Viewing, Updating, Repairing, Logging, Resources
  • scheduling.md: Workspace Scheduling
  • access.md: Accessing workspaces via ports and coder_apps, links to IDEs page
@coder-labeler coder-labeler bot added chore docs Area: coder.com/docs labels Apr 24, 2024
@stirby stirby mentioned this issue Apr 24, 2024
19 tasks
@stirby
Copy link
Collaborator Author

stirby commented May 9, 2024

@stirby stirby closed this as completed May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Area: coder.com/docs
Projects
None yet
Development

No branches or pull requests

1 participant