Project 6: Git Your DS Portfolio Online

Published

May 1, 2020

Walkthrough

Background

GitHub is an online platform where data scientists and developers can communicate and share work. It has also morphed into a tool to house all your work in a portfolio. Think about an Art student and how they have to develop their portfolio of various skills they have across the art classes. Similarly you will want to showcase you skillset across the Data Science skillsets.

As students, you will want to curate your creative work on GitHub using a program called Git. GitHub is the place to share your original work, not your homework assignments. The reading assignments will dive deaper into what to include in your portfolio and what not to include.

Many people store their personal websites, blogs, and project websites on GitHub. Our textbook and course are hosted on GitHub, and you can see J. Hathaway’s or Ryan Hafen’s personal Data Science websites that are hosted on GitHub as well.

For this project, you will be making a public website that is a data science portfolio that will be hosted on GitHub. Your Resume (from project 0) will be one section of your portfolio/website. You should also post Data Science Society projects, personal projects, and any other data science related work you have done outside of class.

Data

Portfolio: BYUI Data Science Portfolio

Readings

Portfolio Resources

Questions and Tasks

  1. Git a Data Science Portfolio in GitHub (main page)
    1. Use the Portfolio Template on your Githhub root directory
      • Navigate to the Data Science Portfolio repo in GitHub.
      • Click the Green Button Use this template and select Create a new repository
      • Click include all branches checkbox, this will include the gh-pages branch
      • Select yourself as the Owner
      • Name the repository as username.github.io where the username is your username on GitHub (Note: If the username part of the repository doesn’t exactly match your username, it won’t work, so make sure to get it right.)
      • Click the Green Button Create repository
    2. Create a new branch gh-pages if you forgot to check the include all branches box (skip otherwise)
      • Click the Branch: main button then view all branches
      • Click the New Branch button
      • Name the branch gh-pages and click the Green Button Create new branch
    3. Modify Pages Settings for Build and deployment from main to gh-pages:
      • Click the Settings tab
      • Scroll down to the Pages section in the left hand menu
      • Locate the Build and deployment section and change Branch from main to gh-pages and leave the right side as /root
    4. Clone the repository to your computer
      • Click the <> Code menu
      • Click the Green Button <> Code and select Open with GitHub Desktop
      • Click the Button Open in Visual Studio Code
    5. Update the _quarto.yml file
      • Change the title to your name
      • Change the repo-url to your code repository url
      • Change the page-footer left: to your name
      • Change the page footer href: to your LinkedIn profile link
      • Scroll to the bottom and change the theme light: and/or dark: to another theme (optional)
    6. Push the changes to GitHub via GitHub Desktop
      • Make sure your current repo in the top left is username.github.io
      • Type a commit message and click the Blue Button Commit to main
      • Click the Blue Button Push origin
    7. Confirm the GitHub Actions are working
      • Navigate to the repo in GitHub and click on the Actions tab
      • Confirm the Update _quarto.yml is working by the yellow circle turning to a green check circle (Note: this can take 3-5min)
    8. Fix the main page loading the ReadMe.md file
      • Run quarto publish gh-pages in the terminal of VS Code
  2. Git your Resume in your Portfolio
    • Move your resume from Project 0 into the Portfolio by replacing the resume.qmd file
    • Push your results to GitHub with GitHub Desktop.

Deliverables:

  1. Complete the questions
  2. Submit a URL link to your portfolio.
Back to top