README
¶
CapstoneDemo
This website represents a transition of CNCS captone content to a web based research, development and integration portfolio. It leverages either github pages or wiki functionaltiy to present a Capstone student's ongoing work to faculty, employers and peers. Github pages is far more advanced and potentially more professional looking but requires some time to learn, particularly if you are going to use Jekyll. Here's the initial advice on github pages or Wiki setup. This repo can be used for templates and examples on markup.
Github Wiki Option
This is pretty straight forward, you essentially just select the Wiki Tab and author your content in any supported markup language as many of you have done in your tech-jounals for CNCS courses. The advantage of the github wiki is that it can remain private between you and chosen collaborators until you are ready to show it close to the end of the Design semester. Github pages are wide open.
Github Pages Option
This option holds far more potential and capabilites than the Wiki option. With this option, comes a good deal of complexity. Our suggestion would be to start with the Wiki option and then if constrained, consider Github pages. Here are some basic tips.
- Create your capstone repo with a readme
- clone your repo locally
- create a docs/index.md directory and file and commit
- enable Github pages
- Select master/docs as a source
- Optionally select a custom domain if you own one (you will have some DNS work to do)
- Select a Jekyll theme
- You should now be able to go to your repo: https://gmcyber.github.io/CapstoneDemo/
- Start hitting the youtubes and github pages documentation for how best to install and use ruby and Jekyll for your preferred operating system. If you find yourself debugging github pages and Jekyll at the expense of actually working on your capstone, pick the simpler wiki strategy.
Project Management
- Scheduling, Kanban boards, Milestones and associated Issues and Progress can be tracked using the Projects Tab
Directories