From 9a86e4a6215c6f4edde04059ddc98371c3557196 Mon Sep 17 00:00:00 2001 From: Andrea Jans <57602919+awjans@users.noreply.github.com> Date: Wed, 15 May 2024 18:24:08 -1000 Subject: [PATCH 1/6] Update README.md Added instructions for how to create your own and then edit the files to personalize. --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/README.md b/README.md index 3a4a21a..891d626 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,55 @@ # Professional Portfolio For details on this professional portfolio, please see https://techfolios.github.io. + +## [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/) + +## [JSON Cheat Sheet](https://www.w3schools.com/js/js_json.asp) + +# Create your own NRTechfolio Repository + +## Login to [GitHub](https://github.com) + +You will need to [login](https://github.com/login) to GitHub or [create an account](https://github.com/signup). If you create an account, please remember that your username will be associated with all of your activities. You might want to keep it professional. + +## Find the [NRTechfolio Template](https://github.com/uhm-descartes/NRTechfolio) Repository + +Search for [uhm-descartes/NRTechfolio](https://github.com/uhm-descartes/NRTechfolio) or follow the provided [link](https://github.com/uhm-descartes/NRTechfolio). + +## Use the Template + +Find the green "Use this template" button in the top left of the screen. Click that button and select "[Create a new repository](https://github.com/new?template_name=NRTechfolio&template_owner=uhm-descartes)" from the dropdown options. + +## Create a New Repository + +On the "Create a new repository" screen, fill in a name for your new repository in the middle of the page. It is suggested to use "NRTechfolio." Click the green "Create repository" button on the bottom right. Github will then create your new repository using the template and redirect you to the new repository when finished. + +# Setup Instructions + +## Turn on Pages + +* Go to [Settings/Pages](../../settings/pages) +* Find the Branch section +* Choose the 'main' branch. + +## Edit Config YAML + +* Edit [_config.yml](_config.yml) +* Change 'Molly Maluhia' to your name on line 3 +* Change 'dport96' to your GitHub username on line 5 +* Change "/template" to "" on line 7 + +## Edit Biography JSON + +* Edit [bio.json](_data/bio.json) +* Make the necessary changes so it reflects you + +## Replace Essay Files + +* In the [essays](essays) folder +* Rename/Edit or Replace the *.md files + +## Replace Project Files + +* In the [projects](projects) folder +* Rename/Edit or Replace the *.md files From 2911a4070ac5398717c0af2ae5d424afee274de4 Mon Sep 17 00:00:00 2001 From: Andrea Jans <57602919+awjans@users.noreply.github.com> Date: Thu, 16 May 2024 07:55:33 -1000 Subject: [PATCH 2/6] Update README.md Adding codespace instructions. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 891d626..9a884e1 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,15 @@ Find the green "Use this template" button in the top left of the screen. Click t On the "Create a new repository" screen, fill in a name for your new repository in the middle of the page. It is suggested to use "NRTechfolio." Click the green "Create repository" button on the bottom right. Github will then create your new repository using the template and redirect you to the new repository when finished. +## Create a New Codespace + +On the "<> Code" tab, find the green "<> Code" button. Click that button and select the "Codespaces" tab. Find and click the "Create codespace on main" button, and Github will a space for you to edit your repository without downloading software to your computer. The codespace will be a website named something like "https://tangerine-parakeet-w47p5rppp725xgx.github.dev/", which you can bookmark for fast access later. The README.md file containing these instructions will be previewed so you can continue to follow along. + # Setup Instructions ## Turn on Pages -* Go to [Settings/Pages](../../settings/pages) +* Go to [Settings/Pages](../../settings/pages) from your GitHub Repository, not the Codespace. * Find the Branch section * Choose the 'main' branch. From d70019ef7f8217119c62184b8fc1abcb37d6d5f2 Mon Sep 17 00:00:00 2001 From: "D. Port Me" Date: Thu, 16 May 2024 08:04:39 -1000 Subject: [PATCH 3/6] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 891d626..ee53045 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ On the "Create a new repository" screen, fill in a name for your new repository * Go to [Settings/Pages](../../settings/pages) * Find the Branch section * Choose the 'main' branch. +* Note the pages URL. It should be somegthing like `https://awjans.github.io/NRTechfolio/` ## Edit Config YAML @@ -53,3 +54,9 @@ On the "Create a new repository" screen, fill in a name for your new repository * In the [projects](projects) folder * Rename/Edit or Replace the *.md files + +## View and Post Portfolio + +* Use the URL in `_config.yml` to view your portfolio +* Post your URL to `# nrtechfolios` on Discord +* Follow-up to ensure you portfolio card appears in the [NRT Portfolio Gallery](https://descartes.manoa.hawaii.edu/nrt-portfolios/) From 83e350d78acad321df2c7586f0142b3c1ea06322 Mon Sep 17 00:00:00 2001 From: Andrea Jans <57602919+awjans@users.noreply.github.com> Date: Thu, 16 May 2024 09:33:42 -1000 Subject: [PATCH 4/6] Update README.md I think this is good enough to use for the presentation --- README.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e72e8ed..b31d4ca 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Professional Portfolio -For details on this professional portfolio, please see https://techfolios.github.io. +For details on this professional portfolio, please see [Techfolios](https://techfolios.github.io). Additional information can be found in the [documentation](https://techfolios.github.io/docs/overview), including [instructions](https://techfolios.github.io/docs/user-guide/cloud-development) on how to use [GitPod](https://www.gitpod.io/). -## [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/) +### [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/) -## [JSON Cheat Sheet](https://www.w3schools.com/js/js_json.asp) +### [JSON Cheat Sheet](https://www.w3schools.com/js/js_json.asp) # Create your own NRTechfolio Repository @@ -24,40 +24,42 @@ Find the green "Use this template" button in the top left of the screen. Click t On the "Create a new repository" screen, fill in a name for your new repository in the middle of the page. It is suggested to use "NRTechfolio." Click the green "Create repository" button on the bottom right. Github will then create your new repository using the template and redirect you to the new repository when finished. -## Create a New Codespace - -On the "<> Code" tab, find the green "<> Code" button. Click that button and select the "Codespaces" tab. Find and click the "Create codespace on main" button, and Github will a space for you to edit your repository without downloading software to your computer. The codespace will be a website named something like "https://tangerine-parakeet-w47p5rppp725xgx.github.dev/", which you can bookmark for fast access later. The README.md file containing these instructions will be previewed so you can continue to follow along. - -# Setup Instructions - ## Turn on Pages * Go to [Settings/Pages](../../settings/pages) from your GitHub Repository, not the Codespace. * Find the Branch section * Choose the 'main' branch. -* Note the pages URL. It should be somegthing like `https://awjans.github.io/NRTechfolio/` +* Note the pages URL. It should be somegthing like `https://awjans.github.io/NRTechfolio/`. This is the URL to your published NRTechfolio and the value will be needed when editing the Config YAML file later. + +## Create a New Codespace + +On the "<> Code" tab, find the green "<> Code" button. Click that button and select the "Codespaces" tab. Find and click the "Create codespace on main" button, and Github will create a codespace for you to edit your repository without downloading software to your computer. The codespace will be a website named something like "https://tangerine-parakeet-w47p5rppp725xgx.github.dev/", which you can bookmark for fast access later. The README.md file containing these instructions will be previewed so you can continue to follow along. + +# Setup Instructions ## Edit Config YAML * Edit [_config.yml](_config.yml) * Change 'Molly Maluhia' to your name on line 3 -* Change 'dport96' to your GitHub username on line 5 +* Change URL on line 5 to match the URL from the Pages configuration of your Repository. * Change "/template" to "" on line 7 -## Edit Biography JSON +## Edit [Biography JSON](https://techfolios.github.io/docs/quick-start/configure-bio-json) -* Edit [bio.json](_data/bio.json) -* Make the necessary changes so it reflects you +* Configure [bio.json](_data/bio.json) +* Make the necessary changes so it reflects you. -## Replace Essay Files +## Configure [Project Files](https://techfolios.github.io/docs/quick-start/configure-projects) -* In the [essays](essays) folder -* Rename/Edit or Replace the *.md files +* In the [projects](projects) folder +* Rename/Edit or Replace the *.md files. Save at least one as a template. -## Replace Project Files +## Configure [Essay Files](https://techfolios.github.io/docs/quick-start/configure-essays) -* In the [projects](projects) folder -* Rename/Edit or Replace the *.md files +* In the [essays](essays) folder +* Rename/Edit or Replace the *.md files. Save at least one as a template. + +## Configure [Resume](https://techfolios.github.io/docs/quick-start/configure-resume) ## View and Post Portfolio From a9b97f63c148c78d470e76fb584220af3b914545 Mon Sep 17 00:00:00 2001 From: "D. Port Me" Date: Thu, 16 May 2024 10:37:36 -1000 Subject: [PATCH 5/6] Update _config.yml --- _config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index ebd0a2e..8f4bac4 100644 --- a/_config.yml +++ b/_config.yml @@ -2,7 +2,7 @@ # Edit next line to provide your own name. title: Molly Maluhia | Professional Portfolio # Edit next line, replacing 'techfolios' with your github username -url: "https://dport96.github.io/NRTechfolio/" +url: "https://uhm-descartes.github.io/NRTechfolio/" # Edit next line so that baseurl is "" if your repo is .github.io baseurl: "/template" From 99e3aa16d92664e1c6c8b2c051fbcb29643b7b1b Mon Sep 17 00:00:00 2001 From: "D. Port Me" Date: Thu, 16 May 2024 11:49:33 -1000 Subject: [PATCH 6/6] Update _config.yml --- _config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index 8f4bac4..eda72b2 100644 --- a/_config.yml +++ b/_config.yml @@ -1,6 +1,6 @@ # REQUIRED CHANGES # Edit next line to provide your own name. -title: Molly Maluhia | Professional Portfolio +title: "Molly Maluhia | Professional Portfolio" # Edit next line, replacing 'techfolios' with your github username url: "https://uhm-descartes.github.io/NRTechfolio/" # Edit next line so that baseurl is "" if your repo is .github.io