From e48a98efb0014786ddb06e430b16fa8ca8f28902 Mon Sep 17 00:00:00 2001 From: Elijah Melton <98496503+elimelt@users.noreply.github.com> Date: Sat, 26 Oct 2024 18:32:43 -0700 Subject: [PATCH 1/6] Update part4-product-spec-learning-phase.md asdfg --- .../project-guidelines/part4-product-spec-learning-phase.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md index cd144da..cae313e 100644 --- a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md +++ b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md @@ -14,7 +14,7 @@ This is an **extremely important phase of your project that should not be taken **We do NOT encourage beginning project development until the entire spec has been completed, presented, and approved.** This is in order to provide your team with useful feedback and to help your team identify any potential gaps in your research or design for your team to fill in. -Here’s the **[Google Docs template](https://hcp-uw.github.io/docs/project-team/resources/product-spec-template)** to get started. You can also navigate to `Resources/Project Spec Template` on this documentation website to find the spec template. This document highlights the requirements you need to meet with your technical spec and also has a template guide to follow. Please reference it closely and ask club leadership if you have any questions. +Here’s the **[Google Docs template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=104753064155446271905&rtpof=true&sd=true)** to get started. You can also navigate to `Resources/Project Spec Template` on this documentation website to find the spec template. This document highlights the requirements you need to meet with your technical spec and also has a template guide to follow. Please reference it closely and ask club leadership if you have any questions. Refer to your designated club lead guide for example specs to read. When you finish a rough draft of your spec, feel free to ask your club lead guide to give it a read-through and provide some feedback! We’re always happy to help and provide support to our project teams. **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get feedback on! Go to **Part 5** to see how this will work. @@ -24,7 +24,7 @@ Refer to your designated club lead guide for example specs to read. When you fin In order to optimize your time with your project, we recommend that you begin exploring the technologies associated with building your product while you are designing. However, don’t go too far into the deep end just in case you might have to switch programming languages. Do some general learning projects with your teammates so that you learn together! But, if your team is sure about which stack they will use, then get started with your learning phase ASAP. -There is no exact order where the learning phase fits into this timeline, but we recommend that you should begin when your team has begun writing their spec and knows what tech stack they plan to use. But the sooner, the better. Here’s a **[list of resources](https://docs.google.com/spreadsheets/d/1S7ma9SIpmoV406har6Ur3AlmY-1kOnJNpcQsGjITu3w/edit#gid=0)** that may cover the languages/technologies you plan to use. If it's not here and you're having trouble finding the resources yourself, contact your project guide for support! +There is no exact order where the learning phase fits into this timeline, but we recommend that you should begin when your team has begun writing their spec and knows what tech stack they plan to use. But the sooner, the better. If it's not here and you're having trouble finding the resources yourself, contact your project guide for support! --- @@ -34,4 +34,4 @@ The following are links to some great examples of project specs. Feel free to us - [AlgoViz](https://docs.google.com/document/d/1aPI6hMQnUmd4xSB1iHznqPPwf6O-75pQ/edit?usp=sharing&ouid=110339665080062140802&rtpof=true&sd=true) - [Syntext](https://docs.google.com/document/d/1nocWKKrvc7k4Md05yd3QKPVLG9CObYTt/edit?usp=sharing&ouid=110339665080062140802&rtpof=true&sd=true) -- [UW BeReal](https://docs.google.com/document/d/1KfsGkbPJdpqmdq-rVXRLRTjEGFZ4OJTN/edit?usp=sharing&ouid=110339665080062140802&rtpof=true&sd=true) \ No newline at end of file +- [UW BeReal](https://docs.google.com/document/d/1KfsGkbPJdpqmdq-rVXRLRTjEGFZ4OJTN/edit?usp=sharing&ouid=110339665080062140802&rtpof=true&sd=true) From 53af6c839ed2d7ac4d3e74fb4998a5333bd68eb6 Mon Sep 17 00:00:00 2001 From: Elijah Melton Date: Sat, 26 Oct 2024 18:37:08 -0700 Subject: [PATCH 2/6] updated readme --- README.md | 14 ++++++++++++++ .../part4-product-spec-learning-phase.md | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 330c23e..27fd568 100644 --- a/README.md +++ b/README.md @@ -27,3 +27,17 @@ $ yarn build This command generates static content into the `build` directory and can be served using any static contents hosting service. +### Deploy + +Our docs are deployed through [vercel](https://vercel.com/husky-coding-projects-projects/docs/deployments) automatically from the `vercel_deploy` branch. Just push changes to `main`, and then merge `main` into `vercel_deploy` to deploy the changes. + +``` +git checkout main +git pull +git add +git commit -m "message" +git push origin main +git checkout vercel_deploy +git merge main +git push origin vercel_deploy +``` diff --git a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md index cae313e..03e0f9f 100644 --- a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md +++ b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md @@ -14,7 +14,7 @@ This is an **extremely important phase of your project that should not be taken **We do NOT encourage beginning project development until the entire spec has been completed, presented, and approved.** This is in order to provide your team with useful feedback and to help your team identify any potential gaps in your research or design for your team to fill in. -Here’s the **[Google Docs template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=104753064155446271905&rtpof=true&sd=true)** to get started. You can also navigate to `Resources/Project Spec Template` on this documentation website to find the spec template. This document highlights the requirements you need to meet with your technical spec and also has a template guide to follow. Please reference it closely and ask club leadership if you have any questions. +Here’s the **[Google Docs template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit#heading=h.gjdgxs)** to get started. You can also navigate to `Resources/Project Spec Template` on this documentation website to find the spec template. This document highlights the requirements you need to meet with your technical spec and also has a template guide to follow. Please reference it closely and ask club leadership if you have any questions. Refer to your designated club lead guide for example specs to read. When you finish a rough draft of your spec, feel free to ask your club lead guide to give it a read-through and provide some feedback! We’re always happy to help and provide support to our project teams. **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get feedback on! Go to **Part 5** to see how this will work. From 1e5c91e2f7a868c8472018c3a706ff9dead9c368 Mon Sep 17 00:00:00 2001 From: Minyoung Cho <109271804+mygcho@users.noreply.github.com> Date: Mon, 28 Oct 2024 22:18:08 -0700 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 27fd568..3a3efe7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. -Here's the website: https://hcp-uw.github.io/hcp-documentation/ +Here's the website: [https://hcp-uw.github.io/hcp-documentation/](https://docs.hcp-uw.com/) ### Installation From 84e54668bb8a9f707a48a3acceef2d3c731db0b4 Mon Sep 17 00:00:00 2001 From: Minyoung Cho <109271804+mygcho@users.noreply.github.com> Date: Tue, 5 Nov 2024 10:54:44 -0800 Subject: [PATCH 4/6] Update part4-product-spec-learning-phase.md Added Technical Design Doc Template for levels 2 & 3 teams, and updated descriptions for each. Changed the title to better fit the new templates. --- .../project-guidelines/part4-product-spec-learning-phase.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md index 03e0f9f..033fead 100644 --- a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md +++ b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md @@ -2,7 +2,7 @@ sidebar_position: 5 --- -# Part 4: Product Spec + Learning Phase +# Part 4: Technical Design Doc/Product Spec + Learning Phase NOTE: These two sections of Part 4 are **especially important** because it dictates your team’s project design and determines whether you are capable of contributing code once your team starts developing. Specifically for the learning phase, if you want to code, you must ensure you learn enough about the language you plan on coding in before you dive into it. See Learning Phase for more info. @@ -14,9 +14,9 @@ This is an **extremely important phase of your project that should not be taken **We do NOT encourage beginning project development until the entire spec has been completed, presented, and approved.** This is in order to provide your team with useful feedback and to help your team identify any potential gaps in your research or design for your team to fill in. -Here’s the **[Google Docs template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit#heading=h.gjdgxs)** to get started. You can also navigate to `Resources/Project Spec Template` on this documentation website to find the spec template. This document highlights the requirements you need to meet with your technical spec and also has a template guide to follow. Please reference it closely and ask club leadership if you have any questions. +There are two different technical design docs/product spec templates we provide to you. Your team can discuss which spec would be ideal for your learning and preparation, but we recommend that level 1 teams use this **[Product Technical Spec Template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=110339665080062140802&rtpof=true&sd=true)**, and that levels 2/3 use this **[Technical Design Doc Template](https://docs.google.com/document/d/1E9T0GCSYztEdXjgMYKJ06Pnkg4aySOzkGxQaabr3UbY/edit?usp=sharing)**. The only difference between the two is that the Technical Design Doc goes into more detail within your tech stack (High-level architecture, Databases, Models, Endpoints, Status Codes, etc.), so it may help your team answer more of the technical questions before you implement your project. It may be helpful to choose between one or another depending on the underlying knowledge between your teammates. Ask your club lead guide if you need guidance in choosing, or need example specs to read! -Refer to your designated club lead guide for example specs to read. When you finish a rough draft of your spec, feel free to ask your club lead guide to give it a read-through and provide some feedback! We’re always happy to help and provide support to our project teams. **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get feedback on! Go to **Part 5** to see how this will work. +When you finish a rough draft of your spec, let your club lead guide know so club leadership can provide feedback! **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get additional feedback from project teams! Go to **Part 5** to see how this will work. --- From c3cd5305218cb7a642480e6a279cf8bf1ea0118b Mon Sep 17 00:00:00 2001 From: Minyoung Cho <109271804+mygcho@users.noreply.github.com> Date: Tue, 5 Nov 2024 11:00:09 -0800 Subject: [PATCH 5/6] Update part4-product-spec-learning-phase.md (#13) --- .../project-guidelines/part4-product-spec-learning-phase.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md index 033fead..9406a83 100644 --- a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md +++ b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md @@ -16,7 +16,7 @@ This is an **extremely important phase of your project that should not be taken There are two different technical design docs/product spec templates we provide to you. Your team can discuss which spec would be ideal for your learning and preparation, but we recommend that level 1 teams use this **[Product Technical Spec Template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=110339665080062140802&rtpof=true&sd=true)**, and that levels 2/3 use this **[Technical Design Doc Template](https://docs.google.com/document/d/1E9T0GCSYztEdXjgMYKJ06Pnkg4aySOzkGxQaabr3UbY/edit?usp=sharing)**. The only difference between the two is that the Technical Design Doc goes into more detail within your tech stack (High-level architecture, Databases, Models, Endpoints, Status Codes, etc.), so it may help your team answer more of the technical questions before you implement your project. It may be helpful to choose between one or another depending on the underlying knowledge between your teammates. Ask your club lead guide if you need guidance in choosing, or need example specs to read! -When you finish a rough draft of your spec, let your club lead guide know so club leadership can provide feedback! **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get additional feedback from project teams! Go to **Part 5** to see how this will work. +When you finish a rough draft of your spec, let your club lead guide know so club leadership (our Design and Tech Teamns) can provide feedback! **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get additional feedback from project teams! Go to **Part 5** to see how this will work. --- From a898d65ec3f24c49aa47fbfab8810507b7c883ec Mon Sep 17 00:00:00 2001 From: Minyoung Cho <109271804+mygcho@users.noreply.github.com> Date: Tue, 5 Nov 2024 11:16:46 -0800 Subject: [PATCH 6/6] Update part4-product-spec-learning-phase.md (#15) Delete one section --- .../project-guidelines/part4-product-spec-learning-phase.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md index 0d52599..9406a83 100644 --- a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md +++ b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md @@ -16,8 +16,6 @@ This is an **extremely important phase of your project that should not be taken There are two different technical design docs/product spec templates we provide to you. Your team can discuss which spec would be ideal for your learning and preparation, but we recommend that level 1 teams use this **[Product Technical Spec Template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=110339665080062140802&rtpof=true&sd=true)**, and that levels 2/3 use this **[Technical Design Doc Template](https://docs.google.com/document/d/1E9T0GCSYztEdXjgMYKJ06Pnkg4aySOzkGxQaabr3UbY/edit?usp=sharing)**. The only difference between the two is that the Technical Design Doc goes into more detail within your tech stack (High-level architecture, Databases, Models, Endpoints, Status Codes, etc.), so it may help your team answer more of the technical questions before you implement your project. It may be helpful to choose between one or another depending on the underlying knowledge between your teammates. Ask your club lead guide if you need guidance in choosing, or need example specs to read! -Here’s the **[Google Docs template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=104753064155446271905&rtpof=true&sd=true)** to get started. You can also navigate to `Resources/Project Spec Template` on this documentation website to find the spec template. This document highlights the requirements you need to meet with your technical spec and also has a template guide to follow. Please reference it closely and ask club leadership if you have any questions. - When you finish a rough draft of your spec, let your club lead guide know so club leadership (our Design and Tech Teamns) can provide feedback! **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get additional feedback from project teams! Go to **Part 5** to see how this will work. ---