Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
joatmon08 committed Oct 3, 2020
1 parent 95fb172 commit 6136f70
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 13 deletions.
9 changes: 6 additions & 3 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
* **I don't see any builds running in Github Actions.** This often happens because you committed a change
before enabling GitHub Actions. Make sure you enable Github Actions first, then commit another change.

* **What if I don't see a social media profile listed and I want to add it?** Feel free to open a GitHub
issue and let us know!
* **How do I add my Facebook, Instagram, or Twitch username to the icons at the bottom?** See [Update Your Social Media Links](./README.md#update-your-social-media-links).

* **How do I add my Facebook username to the icons at the bottom?** See [Updating Social Media Links](./README.md#updating-social-media-links)
* **What if I don't see a social media profile listed and I want to add it?** Feel free to open a GitHub issue and let us know!

* **How do I change the picture on the home page?** See [Update Your Profile Picture](./README.md#update-your-profile-picture).

* **I did this workshop before and I want to use the new stuff you updated on this one. How do I do that?** See [Apply Updates from This Template Repository to Your Portfolio](#apply-updates-from-this-template-repository-to-your-portfolio).
56 changes: 46 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,27 @@
This repository allows you to create your own technical portfolio page!
You are welcome to extend it for other uses, such as blogs or documentation.

> This repository was originally created for Grace Hopper Celebration 2020 and is constantly being updated based
> on the feedback of the workshop participants. If you previously used this repository and want to apply your updates,
> copy your changes and save them somewhere. [You can find the slides here](./assets/ghc.pdf).
**If you have problems with this repository, please see our [frequently asked questions](./FAQ.md) page.**

> This repository was originally created for Grace Hopper Celebration 2020 and is constantly being updated based
> on the feedback of the workshop participants.
> You can find the slides from vGHC [here](./assets/ghc.pdf).
* [Prerequisites](#prerequisites)
* [Getting Started](#getting-started)
* [Edit your portfolio with your personal info](#edit-your-portfolio-with-your-personal-info)
* [Copying the template repository](#copying-the-template-repository)
* [Edit your portfolio with your personal info](#edit-your-portfolio-with-your-personal-info)
* [Update with your name and tagline](#update-with-your-name-and-tagline)
* [Update your site URL and organization](#update-your-site-url-and-organization)
* [Commit your changes](#commit-your-changes)
* [Review the Actions workflow](#review-the-actions-workflow)
* [Updating Social Media Links](#updating-social-media-links)
* [Commit your changes](#commit-your-changes)
* [Review the Actions workflow](#review-the-actions-workflow)
* [Update Your Profile Picture](#update-your-profile-picture)
* [Update Your Social Media Links](#update-your-social-media-links)
* [Update Your About Page](#update-your-about-page)
* [Update Your Projects Page](#update-your-projects-page)
* [Add a Blog](#add-a-blog)
* [Delete Your Portfolio](#delete-your-portfolio)
* [Apply Updates from This Template Repository to Your Portfolio](#apply-updates-from-this-template-repository-to-your-portfolio)

## Prerequisites
* [A GitHub Account](https://github.com/signup)
Expand All @@ -27,6 +32,8 @@ You are welcome to extend it for other uses, such as blogs or documentation.

## Getting Started

### Copying the template repository

You'll need to copy this repository to your Github username and enable a few settings.

1. Navigate to the [tech-portfolio](https://github.com/joatmon08/tech-portfolio) in your web browser.
Expand Down Expand Up @@ -116,8 +123,24 @@ Your URL is "https://YOUR-GITHUB-USERNAME.github.io/tech-portfolio/" and this si

Congratulations! You completed this walkthrough and have a live technical portfolio! Any changes in your forked repo will trigger a new build and will update your site.

## Update Your Profile Picture

Follow these instructions to update your profile picture on the
home page.

1. Save the photo you want to use for your profile and name the photo `profile.png`.

1. Navigate to the `website/static/img` folder of your technical portfolio.

1. Click the Add file drop-down and choose "Upload files".
![website/static/img](assets/profileadd.png)

1. Choose your file called `profile.png` and commit this as a change to your repository.

## Updating Social Media Links
1. Check your live website. The home page should have your photo.


## Update Your Social Media Links

1. Scroll to the bottom of the `website/siteConfig.js` file in the editor.

Expand Down Expand Up @@ -216,4 +239,17 @@ into your tech portfolio if you want to manage your blogs yourself. To add a new
1. Commit your changes and navigate to Actions, where the new build job will run and add your new blog post.

1. To see this page, navigate to your site and click the `Blogs` page.
![show blogs](assets/blog.png)
![show blogs](assets/blog.png)

## Delete Your Portfolio

1. Navigate to Settings in your forked repo.
![Settings](assets/settings.png)

1. Scroll down to the bottom of the page until you see the **Danger Zone**.
![Danger zone](assets/dangerzone.png)

1. Click "Delete this Repository" and follow the prompts to remove the repository.
![Delete](assets/delete.png)

## Apply Updates from This Template Repository to Your Portfolio
Binary file added assets/dangerzone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/profileadd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6136f70

Please sign in to comment.