Skip to content

Commit

Permalink
docs: Explain application_protocol better, and point the "Report Do…
Browse files Browse the repository at this point in the history
…cs Issue" to the docs Github issue template (#320)

## Description:
Two tiny bugfixes

## Is this change user facing?
YES

## References (if applicable):
Fixes #318 
Fixes #319

---------

Co-authored-by: mieubrisse <mieubrisse@gmail.com>
  • Loading branch information
mieubrisse and mieubrisse authored Mar 24, 2023
1 parent f4808da commit 8e4cdd2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
11 changes: 7 additions & 4 deletions docs/docs/reference/starlark-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,13 +193,16 @@ port_spec = PortSpec(
# The port number which we want to expose
# MANDATORY
number = 3000,

# Transport protocol for the port (can be either "TCP" or "UDP")
# Optional (DEFAULT:"TCP")
# OPTIONAL (DEFAULT:"TCP")
transport_protocol = "TCP",

# Application protocol for the port
# Optional
# Application protocol for the port that will be displayed in front of URLs containing the port
# For example:
# "http" to get a URL of "http://..."
# "postgresql" to get a URL of "postgresql://..."
# OPTIONAL
application_protocol = "http",
)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ const config = {
dropdownActiveClassDisabled: true,
},
{
href: 'https://github.com/kurtosis-tech/kurtosis/issues/new/',
href: 'https://github.com/kurtosis-tech/kurtosis/issues/new?assignees=leeederek&labels=docs&template=docs-issue.yml&title=%5BDocs%5D%3A+',
position: 'right',
label: 'Report Docs Issue',
},
Expand Down

0 comments on commit 8e4cdd2

Please sign in to comment.