Skip to content

Commit

Permalink
updated changes in 2.7.b.i
Browse files Browse the repository at this point in the history
  • Loading branch information
jenjenkayi committed Nov 13, 2024
1 parent 0dcc7f1 commit c589fd1
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The following is a set of guidelines for contributing to the website repository,
- [**2.7 Working on an issue**](#27-working-on-an-issue)
- [**2.7.a Working on an issue (1): Verify current branch is `gh-pages`**](#27a-working-on-an-issue-1-verify-current-branch-is-gh-pages)
- [**2.7.b Working on an issue (2): Creating and testing your issue branch**](#27b-working-on-an-issue-2-creating-and-testing-your-issue-branch)
- [**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:**](#i-to-test-your-issue-branch-locally-run-the-command-docker-compose-up-from-a-terminal-window-the-website-will-then-be-accessible-at-httplocalhost4000--a-few-notes-regarding-docker)
- [**i. A few notes regarding Docker:**](#i-a-few-notes-regarding-docker)
- [**2.7.c Working on an issue(3): Prepare your changes to push to your repository**](#27c-working-on-an-issue3-prepare-your-changes-to-push-to-your-repository)
- [**i. Prepare repo changes (1): Use the `git add` command to stage your changes.**](#i-prepare-repo-changes-1-use-the-git-add-command-to-stage-your-changes)
- [**ii. Prepare repos changes (2): Use the `git status` command to see what files are staged.**](#ii-prepare-repos-changes-2-use-the-git-status-command-to-see-what-files-are-staged)
Expand Down Expand Up @@ -546,10 +546,12 @@ We urge developers to be cautious using `git add`. In general it is not advisabl
When you've finished working on your issue, follow the steps below to prepare your changes to push to your repository.

##### **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:**
##### **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.

- The Docker Desktop application must be running, otherwise `docker-compose up` will not work
- Docker pulls an image from Dockerhub.com which enables Docker to built the website locally with the same environment used to build the site at GitHub. As the environment and dependencies change, HfLA engineers update the Dockerhub image; however, the image updated at Dockerhub is not automatically downloaded, so it is necessary to periodically check to determine if the local image is outdated, and if so, to pull the updates from Dockerhub. Use this process:
- Docker pulls an image from Dockerhub.com which enables Docker to build the website locally with the same environment used to build the site at GitHub. As the environment and dependencies change, HfLA engineers update the Dockerhub image; however, the image updated at Dockerhub is not automatically downloaded, so it is necessary to periodically check to determine if the local image is outdated, and if so, to pull the updates from Dockerhub. Use this process:

- In the Docker Desktop application, from the `Images` page, click the Action menu (3 dots) for the image `hackforlaops/ghpages`, select option `View details`.
- In the new Docker Desktop application, select option `View packages and CVEs` instead.
Expand Down

0 comments on commit c589fd1

Please sign in to comment.