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

Jump to bottom

Add a section to the README for ports #61

Merged
merged 2 commits into from
Jun 16, 2021
Merged

Add a section to the README for ports #61

merged 2 commits into from
Jun 16, 2021

Conversation

jsf9k
Copy link
Member

@jsf9k jsf9k commented Jun 15, 2021 •
edited
Loading

🗣 Description

This pull request adds a section to README.md for ports exposed by the container.

💭 Motivation and context

@dav3r noticed in cisagov/postfix-docker#25 that such a section was missing from the skeleton.

🧪 Testing

I viewed the rendered Markdown and verified that it looked good.

✅ Checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
  • All new and existing tests pass.

@jsf9k jsf9k added the documentation This issue or pull request improves or adds to documentation label Jun 15, 2021
@jsf9k jsf9k self-assigned this Jun 15, 2021
@jsf9k jsf9k marked this pull request as ready for review June 15, 2021 13:57
@jsf9k jsf9k requested review from dav3r, felddy and mcdonnnj as code owners June 15, 2021 13:57
dav3r
dav3r approved these changes Jun 15, 2021
View reviewed changes
Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

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

I like it! 🚀

@jsf9k jsf9k mentioned this pull request Jun 15, 2021
Merged
1 task
mcdonnnj
mcdonnnj requested changes Jun 16, 2021
View reviewed changes
Copy link
Member

@mcdonnnj mcdonnnj left a comment

Choose a reason for hiding this comment

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

I don't think this section reflects the configuration of this image. I'm glad someone caught that it was missing here though!

README.md Outdated Show resolved Hide resolved
@jsf9k @dav3r
Add a section to the README for ports
d091518 
Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
@jsf9k jsf9k force-pushed the documentation/add-ports-section branch from b2e84d4 to d091518 Compare June 16, 2021 14:07
@jsf9k @mcdonnnj
Document the single exposed (but non-functional) port
1f6d090 
Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k jsf9k requested a review from mcdonnnj June 16, 2021 14:14
mcdonnnj
mcdonnnj approved these changes Jun 16, 2021
View reviewed changes
Copy link
Member

@mcdonnnj mcdonnnj left a comment

Choose a reason for hiding this comment

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

Thanks for getting this added!

@jsf9k jsf9k merged commit b1aa84c into develop Jun 16, 2021
@jsf9k jsf9k deleted the documentation/add-ports-section branch June 16, 2021 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dav3r dav3r dav3r approved these changes

@mcdonnnj mcdonnnj mcdonnnj approved these changes

@felddy felddy Awaiting requested review from felddy felddy is a code owner

Assignees

@jsf9k jsf9k

Labels
documentation This issue or pull request improves or adds to documentation
Projects
Skeleton Maintenance
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jsf9k @dav3r @mcdonnnj