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.

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

Update Docker info in CONTRIBUTING.md Section 2.7.b #7631

Merged

Conversation

jenjenkayi
Copy link
Member

Fixes #7576

What changes did you make?

Why did you make the changes (we will use this info to test)?

  • To add instructions for keeping the local Docker image up to date by pulling updates from Dockerhub

For Reviewers: Do not review changes locally, rather, review changes at https://github.com/jenjenkayi/website/blob/update-contributing.md-7576/CONTRIBUTING.md.

Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)

  • No visual changes to the website

Copy link

Want to review this pull request? Take a look at this documentation for a step by step guide!


Note that CONTRIBUTING.md cannot previewed locally; rather it should be previewed at this URL:

https://github.com/jenjenkayi/website/blob/update-contributing.md-7576/CONTRIBUTING.md  

@github-actions github-actions bot added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Complexity: Medium Feature: Wiki size: 0.5pt Can be done in 3 hours or less labels Oct 23, 2024
@pluto-bell pluto-bell self-requested a review October 24, 2024 02:19
@codyyjxn codyyjxn self-requested a review October 24, 2024 02:23
Copy link
Member

@codyyjxn codyyjxn left a comment

Choose a reason for hiding this comment

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

@jenjenkayi Thank you for taking on this issue.
I'm not sure why I am not able to see the changes through the link that you provide in the pr.
It seems like you made the correct changes. Are you able to see the changes on your end from the url that you provided ?

Copy link
Member

@pluto-bell pluto-bell left a comment

Choose a reason for hiding this comment

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

Great work, everything looks solid 👍 and the link you provided did work for me.

The one thing I noticed is that the hyperlinks at the top of the CONTRIBUTING.md page no longer work for sections 2.7b and i due to the title name changes.

My suggestion is to:

  • edit the hyperlinks at the top of the CONTRIBUTING.md file so that they reference the new title names for 2.7b and its subsection i so they can continue to be easily accessible via the table of contents hyperlinks.

  • after completing this change double-check your work to ensure that clicking each of those hyperlinks redirect you to sections 2.7b and i, respectively.

If you have any questions don't hesitate to reach out.

@pluto-bell
Copy link
Member

pluto-bell commented Oct 24, 2024

Great work, everything looks solid 👍 and the link you provided did work for me.

The one thing I noticed is that the hyperlinks at the top of the CONTRIBUTING.md page no longer work for sections 2.7b and i due to the title name changes.

My suggestion is to:

  • edit the hyperlinks at the top of the CONTRIBUTING.md file so that they reference the new title names for 2.7b and its subsection i so they can continue to be easily accessible via the table of contents hyperlinks.
  • after completing this change double-check your work to ensure that clicking each of those hyperlinks redirect you to sections 2.7b and i, respectively.

If you have any questions don't hesitate to reach out.

Thanks for making the adjustments, @jenjenkayi!

I'll let someone who has more authority than me take a look at these notes and make the final decision on subsection i:

  • It looks like 2.7.b subsection i isn't getting properly connected still due to the link inside the full string:
    • new title: i. To test your issue branch locally, run the command "docker-compose up" from a terminal window. The website will then be accessible at http://localhost:4000/ . A few notes regarding Docker:
  • My thought is to make subsection i more like an actual title so we can still easily hyperlink it
    • previous title: What if you cannot see your changes locally within Docker?
  • Since I don't have jurisdiction, just putting in my 2 cents (:

@jenjenkayi
Copy link
Member Author

@pluto-bell Thank you for reviewing! I have checked both links, they are working now.

@jenjenkayi jenjenkayi requested a review from pluto-bell October 24, 2024 21:29
@jenjenkayi
Copy link
Member Author

@codyyjxn Thank you for reviewing! Yes, the changes are up to date from the url provided.

@santisecco
Copy link
Member

Review ETA: 2 PM 10/26/24
Availability: Friday-Saturday 11 AM-3 PM

@santisecco
Copy link
Member

-Change "the Docker Desktop application..." with "The Docker Desktop application..." in the first bullet point.

-I would personally keep the last two bullet points from the previous version and add them at the end.

  • If the above steps did not resolve your issue, run through the first three steps again, but try resetting your browser's cache before restarting docker (you can also try running http://localhost:4000 in another browser).

  • If you still do not see your changes after trying these steps, please feel free to reach out to the team in the #hfla-site Slack channel, or bring up your issue in a dev meeting.

-In the new Docker version when clicking the three dots, I don't see the option "View details" instead I see the option "View packages and CVEs" I would add that just in case.
I don't know if I would add the screenshot also of the new version or just the text.
Screenshot 2024-10-26 161622

@jenjenkayi
Copy link
Member Author

@santisecco Updated per your comments. Please review. Thank you!

santisecco
santisecco previously approved these changes Oct 31, 2024
Copy link
Member

@santisecco santisecco left a comment

Choose a reason for hiding this comment

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

Hi @jenjenkayi thank you for the updates and adding the screenshot for the new version of docker. It looks great.
Thanks for working on this.

@jenjenkayi
Copy link
Member Author

@pluto-bell I have updated the changes. Please review it again. Thank you

@codyyjxn
Copy link
Member

codyyjxn commented Nov 5, 2024

@jenjenkayi Thank you for making the changes. Please request a review so i can approve this.

@jenjenkayi jenjenkayi requested a review from codyyjxn November 5, 2024 22:39
codyyjxn
codyyjxn previously approved these changes Nov 5, 2024
Copy link
Member

@codyyjxn codyyjxn left a comment

Choose a reason for hiding this comment

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

@jenjenkayi Thank you for taking this issue on. Keep it up !

@t-will-gillis t-will-gillis self-requested a review November 10, 2024 22:00
Copy link
Member

@t-will-gillis t-will-gillis left a comment

Choose a reason for hiding this comment

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

Hi @jenjenkayi Thank you for working on this! Everything is looking great and it appears that you have satisfied the original issue. There are a couple of edits, however, that I believe we will want to make:

  • As @pluto-bell had mentioned earlier, I agree that the header for 2.7.i should be a title, and currently this reads as a paragraph. I think that the best solution is to change the text on line 55 to something like (and please check that this is formatted correctly):
    - [**i. A few notes regarding Docker:**](#i-a-few-notes-regarding-docker)  
    
    and line 249 to (please remove the space between the link and the period):
    ##### **i. A few notes regarding Docker:**   
    
    - To test your issue branch locally, run the command "docker-compose up" from a terminal window. The website will then be accessible at http://localhost:4000. 
    
  • Also, on line 552 there is a misspelling "...which enables Docker to built the website locally..." Here "built" should be "build"

Again, you followed the issue correctly but would you please make these edits?
Thanks!

@jenjenkayi jenjenkayi dismissed stale reviews from codyyjxn and santisecco via c589fd1 November 13, 2024 22:04
Copy link
Member

@t-will-gillis t-will-gillis left a comment

Choose a reason for hiding this comment

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

Hey @jenjenkayi This looks great! Thanks for making the edits.

@t-will-gillis t-will-gillis merged commit bab5cce into hackforla:gh-pages Nov 13, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Feature: Wiki role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less
Projects
Development

Successfully merging this pull request may close these issues.

Update CONTRIBUTING.md Section 2.7.b with information about Docker
5 participants