Skip to content

docs: reduce the amount of detail in the open/close port methods#1006

Merged
benhoyt merged 5 commits intocanonical:mainfrom
tonyandrewmeyer:open-close-port-docs-918
Sep 21, 2023
Merged

docs: reduce the amount of detail in the open/close port methods#1006
benhoyt merged 5 commits intocanonical:mainfrom
tonyandrewmeyer:open-close-port-docs-918

Conversation

@tonyandrewmeyer
Copy link
Collaborator

@tonyandrewmeyer tonyandrewmeyer commented Sep 21, 2023

Simplify the open_port() and close_port() documentation:

  • Link to the Juju documentation (soon to also be updated) to minimise the amount of syncing required
  • Note that the behaviour differs between K8s sidecar and machine charms
  • Remove the note that juju expose/juju unexpose is required (true for machine, not true for k8s sidecar)

Fixes #918

@tonyandrewmeyer tonyandrewmeyer added the docs Improvements or additions to documentation label Sep 21, 2023
Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Changes look fine, just a typo, and the docs build seems to be failing (confirms my dislike of ReST).

tonyandrewmeyer and others added 2 commits September 21, 2023 13:40
Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
@tonyandrewmeyer
Copy link
Collaborator Author

the docs build seems to be failing (confirms my dislike of ReST).

Ah, my bad. I built the docs after doing open_port() to make sure that I had the link syntax correct, and then lazily did not do that after making the close_port() change, and it's angry that the external link is there twice. Will fix.

@benhoyt benhoyt merged commit 7f71d6e into canonical:main Sep 21, 2023
@tonyandrewmeyer tonyandrewmeyer deleted the open-close-port-docs-918 branch September 22, 2023 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve open_port / close_port docs

3 participants