diff --git a/docs/about/agreement.md b/docs/about/agreement.md index 3d48e2d2d7062f7ac27bbbec6b6131e695329748..c5b0ae2526a823aca4c9c9915955719f8591cfb3 100644 --- a/docs/about/agreement.md +++ b/docs/about/agreement.md @@ -1,5 +1,35 @@ -# Student Agreement +## Fab Academy Student Agreement -This page is a placeholder. -Paste here your agreement. +**The Fab Academy is responsible for:** + +Teaching principles and practices of digital fabrication +Arranging lectures, recitations, meetings, and events for the class +Evaluating and providing feedback on student work +Offering clear standards for completing assignments +Certifying and archiving student progress +Supervising class preparation +Reviewing prospective students, instructors, and labs +Providing central staff and infrastructure for students, instructors, and labs +Fund-raising for costs not covered by student tuition +Managing and reporting on the program's finances, results, and impacts +Publicizing the program +Promoting a respectful environment free of harassment and discrimination +Encourage a diverse, accessible, and equitable community + +**I am a Fab Academy student, responsible for** + +Attending class lectures and participating in reviews +Developing and documenting projects assigned to introduce and demonstrate skills +Allowing the Fab Academy to share my work (with attribution) in the class for purposes compatible with its mission +Honestly reporting on my work, and appropriately attributing the work of others (both human and machine) +Working safely +Leaving workspaces in the same (or better) condition than I found them +Participating in the upkeep of my lab +Ensuring that my tuition for local and central class costs is covered +Following locally applicable health and safety guidance +Promoting a respectful environment free of harassment and discrimination + +Signed by committing this file in my repository, + +Dan Stone \ No newline at end of file diff --git a/docs/assignments/week01.md b/docs/assignments/week01.md index 1551e34ad818f5ea02ed4b62212fdc8c714789ea..9b78213a18d998a59727fe6db302e0bd279296f7 100644 --- a/docs/assignments/week01.md +++ b/docs/assignments/week01.md @@ -1,111 +1,171 @@ -# 1. Principles and practices +# Fab week 1 -This week I worked on defining my final project idea and started to getting used to the documentation process. +I found this week to be a bit intemidating as software / web design in general +and writing in particular is not my strong suit. Nothing to gain by waiting so I dove +right in. -## Research +Decided to start off with MKDocs as having that in place would make documentation of +everything else easier. -"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum." +## Installing MKDocs -> "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum." +Started off trying to install MKDocs. I linked off the mkdocs website into the " getting started " page -## Useful links +https://www.mkdocs.org/getting-started/ -- [Jekyll](http://jekyll.org) -- [Google](http://google.com) -- [Markdown](https://en.wikipedia.org/wiki/Markdown) + -## Code Example +And from there moved to the installation guide at: -Use the three backticks to separate code. + https://www.mkdocs.org/user-guide/installation/ + + + + +**Problem #1 - no pip or python on my PC…..** + + + + + +## Installing Python + + Tried installing Python from the website www.python.org but once I got back into the CMD that did not seem to work + + + + + + After trying different commands in the CMD terminal the windows app store python came up!!! and after installing the app from there things seems to get back on track + + After what I thought was success I seem to hit a wall to get more progress.... + + + +## Visual Studio + +Next we needed to get IDE in place. + +This was very straight forward off the Visual Studio website + +https://visualstudio.microsoft.com/vs/ + + + +## Mattermost + +Got the link to set up Matter most. Followed direction for Windows install + + + + +Added the channel from the fab admin email and logged in using the Gitlab button + + + +And we are good to go + + + +## GitLab + +This is a litte confusion but I fould a guide on +https://docs.gitlab.com/ee/topics/git/how_to_install_git/ + +and decided to follow it. +Step 1: Install GIT from https://git-scm.com/ + + + +Thanks I went ahead with the commands to install and create a key + + + +Now I went ahead from Git Bash using the following command: + +``` +cat ~/.ssh/id_ed25519.pub | clip +``` +Now the SSH was copied into my clipboard and the next step is to add that to GitLab + +Under profile--> prefrences there is an SSH Key option + + + +and we are now goot to do...I think + + + +So I decided to check but running the following command ``` -// the setup function runs once when you press reset or power the board -void setup() { - // initialize digital pin LED_BUILTIN as an output. - pinMode(LED_BUILTIN, OUTPUT); -} - -// the loop function runs over and over again forever -void loop() { - digitalWrite(LED_BUILTIN, HIGH); // turn the LED on (HIGH is the voltage level) - delay(1000); // wait for a second - digitalWrite(LED_BUILTIN, LOW); // turn the LED off by making the voltage LOW - delay(1000); // wait for a second -} +ssh -T git@gitlab.fabcloud.org ``` -## Gallery + + + +Success!!!! + +So now it is time to clone the repository. The command itself seemed easy enough but +I did have to try a number of times until I got the address correct. + + + + +So now it is time to access the local repo and see if I can update something + +I load Git Gui + + + +It took my a bit of time to figure out were the repo cloned but I noticed it said "dan-stone" in the +clone + + + +A quick search located that folder in the top of the C: drive and so pointing the GitGui "open repo" +got us rocking and rolling + + - -## Video -### From Vimeo + -<iframe src="https://player.vimeo.com/video/10048961" width="640" height="480" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe> -<p><a href="https://vimeo.com/10048961">Sound Waves</a> from <a href="https://vimeo.com/radarboy">George Gally (Radarboy)</a> on <a href="https://vimeo.com">Vimeo</a>.</p> +## Uploading my first website -### From Youtube +So I have been diligently in MKDocs and ignoring the parts of the documentation that +talk about "build" command....i have been using ```mkdocs serve``` to start a local site +that I can view and it all seems great. -<iframe width="560" height="315" src="https://www.youtube.com/embed/jjNgJFemlC4" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe> +Well I decided to upload my website to git and it all seems simple enough.... -## 3D Models +I copy the MKDocs folder contents to the "Public Folder" in the repository and hit push -<div class="sketchfab-embed-wrapper"><iframe width="640" height="480" src="https://sketchfab.com/models/658c8f8a2f3042c3ad7bdedd83f1c915/embed" frameborder="0" allow="autoplay; fullscreen; vr" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe> +GitGui give me back a "Success" green light and I hit the public website address to find -<p style="font-size: 13px; font-weight: normal; margin: 5px; color: #4A4A4A;"> - <a href="https://sketchfab.com/models/658c8f8a2f3042c3ad7bdedd83f1c915?utm_medium=embed&utm_source=website&utm_campaign=share-popup" target="_blank" style="font-weight: bold; color: #1CAAD9;">Dita's Gown</a> - by <a href="https://sketchfab.com/francisbitontistudio?utm_medium=embed&utm_source=website&utm_campaign=share-popup" target="_blank" style="font-weight: bold; color: #1CAAD9;">Francis Bitonti Studio</a> - on <a href="https://sketchfab.com?utm_medium=embed&utm_source=website&utm_campaign=share-popup" target="_blank" style="font-weight: bold; color: #1CAAD9;">Sketchfab</a> -</p> -</div> + +It seems that other folks in my class had a similar issue at the same time and a discussion +on mkdocs vs. html made me realize that I should probably go back and revisit the ```mkdocs build``` +command. -## Use HTML +I get a folder named "site" filled with html files of my website. -You may also embed HTML in your markdown files +I quickly drop these files into my "Public folder" of the repository and commeit a push.... -<hr /> +Success....kinds of....web site is up but no picture are showing ..... + -Try having a seperator line +I do some more research and looks like what I thought was the syntaxt for a relative pic link was not +right. +I kept using +`````` -<hr /> +but is should be +`````` -<table border="1"> - <thead> - <tr> - <th>ID</th> - <th>First Name</th> - <th>Last Name</th> - </tr> - </thead> - <tbody> - <tr> - <td>235312</td> - <td>John</td> - <td>Doe</td> - </tr> - <tr> - <td>453123</td> - <td>Mark</td> - <td>Jones</td> - </tr> - <tr> - <td>998332</td> - <td>Jonathan</td> - <td>Smith</td> - </tr> - <tr> - <td>345612</td> - <td>Andrew</td> - <td>McArthur</td> - </tr> - <tr> - <td>453123</td> - <td>Adam</td> - <td>Fuller</td> - </tr> - </tbody> -</table> +Qucik correct, new build and upload and we are good to go!!