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 better build instructions to the README. #51

Merged
merged 16 commits into from
Jun 3, 2021
Merged

Add better build instructions to the README. #51

merged 16 commits into from
Jun 3, 2021

Conversation

felddy
Copy link
Member

@felddy felddy commented Apr 6, 2021 •
edited
Loading

🗣 Description

Closes #50

  • Add instructions for cross-platform builds
  • Clean up shields
  • Clean up tables for each Docker configuration item
  • Add section about supported tags

💭 Motivation and context

It was pointed out that the instructions for cross platform builds were: lacking.

🧪 Testing

Tested locally and in CI.

📷 Screenshots (if appropriate)

✅ 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.

@felddy
Add better build instructions to the README.
6427dfa 
* Add instructions for cross-platform builds
* Clean up shields
* Clean up tables for each Docker configuration item
* Add section about supported tags
@felddy felddy added documentation This issue or pull request improves or adds to documentation blocked This issue or pull request is awaiting the outcome of another issue or pull request labels Apr 6, 2021
@felddy felddy self-assigned this Apr 6, 2021
@felddy felddy added the improvement This issue or pull request will add or improve functionality, maintainability, or ease of use label Apr 6, 2021
jsf9k
jsf9k approved these changes Apr 6, 2021
View reviewed changes
Copy link
Member

@jsf9k jsf9k left a comment

Choose a reason for hiding this comment

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

Definitely helps. Thank you.

dav3r
dav3r approved these changes Apr 6, 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.

Lovely! Nice improvements all around. 🥏

mcdonnnj
mcdonnnj approved these changes Apr 7, 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 these in here. 📜✨ I did have some questions/suggestions below for your input/consideration.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
hillaryj
hillaryj reviewed Apr 8, 2021
View reviewed changes
README.md Show resolved Hide resolved
hillaryj
hillaryj reviewed Apr 8, 2021
View reviewed changes
Copy link
Contributor

@hillaryj hillaryj left a comment

Choose a reason for hiding this comment

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

Looking good! Here are some nits.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
felddy and others added 9 commits April 8, 2021 14:55
@felddy @hillaryj
Update README.md
d354a54 
Co-authored-by: Hillary <hillary.jeffrey@trio.dhs.gov>
@felddy @hillaryj
Update README.md
267e56b 
Co-authored-by: Hillary <hillary.jeffrey@trio.dhs.gov>
@felddy @hillaryj
Update README.md
d0d474c 
Co-authored-by: Hillary <hillary.jeffrey@trio.dhs.gov>
@felddy @hillaryj
Update README.md
d58e50c 
Co-authored-by: Hillary <hillary.jeffrey@trio.dhs.gov>
@felddy @hillaryj
Update README.md
c8ea902 
Co-authored-by: Hillary <hillary.jeffrey@trio.dhs.gov>
@felddy @mcdonnnj
Update README.md
f014b4c 
Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>
@felddy @hillaryj
Update README.md
4df9da2 
Co-authored-by: Hillary <hillary.jeffrey@trio.dhs.gov>
@felddy @hillaryj
Update README.md
2c06a69 
Co-authored-by: Hillary <hillary.jeffrey@trio.dhs.gov>
@felddy @hillaryj
Update README.md
6a11d94 
Co-authored-by: Hillary <hillary.jeffrey@trio.dhs.gov>
@felddy felddy force-pushed the improvement/readme_build_instructions branch from 0e1a5f1 to e5f4266 Compare April 26, 2021 16:33
felddy added 2 commits April 26, 2021 12:37
@felddy
Unquote port integers as this is now a parse error in Docker.
9938f67
@felddy
Change compose specification version to match pyenv testing composition.
67f3a0c 
The version attribute has been depricated and will be removed once our 
systems move to a more recent release.
@felddy felddy force-pushed the improvement/readme_build_instructions branch from e5f4266 to 67f3a0c Compare April 26, 2021 16:38
@felddy felddy mentioned this pull request Apr 26, 2021
Open
@felddy felddy mentioned this pull request Apr 26, 2021
Closed
@felddy @hillaryj
Update README.md
3b62397 
Co-authored-by: Hillary <hillary.jeffrey@trio.dhs.gov>
@felddy felddy removed the blocked This issue or pull request is awaiting the outcome of another issue or pull request label Apr 26, 2021
jsf9k
jsf9k approved these changes Apr 26, 2021
View reviewed changes
Copy link
Member

@jsf9k jsf9k left a comment

Choose a reason for hiding this comment

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

Still approved, although I made one small suggestion that you can take or leave as you see fit.

README.md Outdated Show resolved Hide resolved
dav3r
dav3r approved these changes Apr 26, 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.

Still approved here also. 👍

felddy and others added 2 commits May 25, 2021 17:12
@felddy @jsf9k
Update README.md
d405a76 
Co-authored-by: Shane Frasier <jeremy.frasier@trio.dhs.gov>
@mcdonnnj
Merge branch 'develop' into improvement/readme_build_instructions
688f98b
@mcdonnnj mcdonnnj merged commit b1949f9 into develop Jun 3, 2021
@mcdonnnj mcdonnnj deleted the improvement/readme_build_instructions branch June 3, 2021 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mcdonnnj mcdonnnj mcdonnnj approved these changes

@hillaryj hillaryj hillaryj left review comments

@dav3r dav3r dav3r approved these changes

@jsf9k jsf9k jsf9k approved these changes

Assignees

@felddy felddy

Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
Skeleton Maintenance
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add better documentation for cross building container from source.
5 participants
@felddy @jsf9k @hillaryj @dav3r @mcdonnnj