Merge branch 'main' of https://github.com/uhm-descartes/NRTechfolio

README.md

@@ -1,3 +1,68 @@
 # 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/)
+
+### [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.
+
+## 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/`. 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 URL on line 5 to match the URL from the Pages configuration of your Repository.
+* Change "/template" to "" on line 7
+
+## Edit [Biography JSON](https://techfolios.github.io/docs/quick-start/configure-bio-json)
+
+* Configure [bio.json](_data/bio.json)
+* Make the necessary changes so it reflects you.
+
+## Configure [Project Files](https://techfolios.github.io/docs/quick-start/configure-projects)
+
+* In the [projects](projects) folder
+* Rename/Edit or Replace the *.md files. Save at least one as a template.
+
+## Configure [Essay Files](https://techfolios.github.io/docs/quick-start/configure-essays)
+
+* 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
+
+* 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/)

_config.yml

@@ -1,8 +1,8 @@
 # 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://dport96.github.io/NRTechfolio/"
+url: "https://uhm-descartes.github.io/NRTechfolio/"
 # Edit next line so that baseurl is "" if your repo is <username>.github.io
 baseurl: "/template"