Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 3.71 KB

README.md

File metadata and controls

68 lines (43 loc) · 3.71 KB

Example Outline and Notes for CSC/DSP 310 Portfolio

To make some of the instructions more concrete I put some (not real) example outline content in this portfolio. This is not an actual portfolio, I have no actual code, it was just a 15 minute ouline of possible types of content that you might do. Note that your actual portfolio might look very different:

  • you could have more or fewer separate chapters
  • you might focus on all level 3
  • you might focus on all level 2

Look at the following files in particular:

Getting Started

Portfolio template for CSC and DSP 310

this is designed to be used by accepting an assignment on github classroom(the url is like: https://github.com/rhodyprog4ds/portfolio-username), if you are viewing the source repository(the name url is https://github.com/rhodyprog4ds/portfolio), you will have to fork first

Setup Publishing

On GitHub

GitHub Actions are setup for publishing your Jupyter book on GitHub, you can view the rendered website by:

  • go to the 'Settings' tab at the top, scroll down to the 'GitHub Pages' section and set the gh-pages branch and root to the source. Then that page will show you the url of your rendered portfolio.Once you turn this on once, you'll be able to view your updates whenever you push changes to the main branch
  • Change to the gh-pages branch above and view portfolio.pdf to see your contents as a pdf, that you can download
  • Offline: switch to the gh-pages branch with git checkout gh-pages and pull that branch after you push to main.

If you make your html public, for the semester, please keep it in the rhodyprog4ds organization. In December, if you wish you will be able to transfer ownership of your portfolio to your GitHub account to move it from rhodyprog4ds.github.io/portfolio-username to username.github.io/whatever-you-want.

You can build locally by

You can run Jupyter book offline, but you do not need to. There are some parts of this that are experimental and may be hard to get working on Windows or even Mac, but work on the Linux systems that GitHub hosts.

Make it yours

  • edit _config.yml to set your name as author
  • edit about/index.md to be the introduction of your portfolio and a biography of yourself
    • change the logo if you wish

Using your Jupyter Book Portfolio

You can use it by adding files, either markdown files or jupyter notebooks to the folder and pushing or by uploading to the repository.

Optionally, there's a lot of other features. For information on how to use special formatting, see the Jupyter Book Documentation and the example files in the template_files/ folder of this repository.

Preparing for Portfolio Checks

(not assignment 1, only portfolio checks)

  • add files with your contents to the repository, commit all changes directly to the main branch
  • edit the appropriate submission_x_intro.md
  • edit _toc.yml as follows to include each file you've added following the example below, but with your own file names.
- file: submission_1_intro
  sections:
    - file: check1/notesonx
    - file: check1/reflectionb
  • when you're ready to submit, create a pull request with feedback as the base branch and main as the head branch (labeled "compare")