CHAL-48 #update Added wiki Home page

[CaptainExtremis]

Checklist

Please ensure you have followed all of the steps below before submitting a pull request:

• Include the corresponding Jira issue key and #done in the PR title, like so: "JRA-123 #done Migrate Election Reminders"
• Verify that the code compiles (npm run dev)
• Verify that the project builds (npm run build:local)
• [-] Verify that all tests pass
• [-] Verify that unit tests cover 100% of the code
• [-] Create Storybook stories for visual components
• [-] Verify that any visual components match the Figma
• [-] Test with a screen reader (if applicable)
• Document your code with TSDoc comments
• Format your code with Prettier

Overview

REQUIRED
Created basic Home Page for 8by8 Challenge wiki

Test Plan

REQUIRED
N/A

Follow ups

N/A

[dvorakjt]

Hi Phillip,

Good news--I verified that the Github Actions workflow works as expected. However, there are a lot of files included with this PR that I do not wish to merge into the main 8by8 repo.

The only files that should be added by this PR are:

.github/workflows/publish-to-wiki.yml
wiki/Home.md

Please remove all other new files. Please do not add anything to the .gitignore and please remove all files that you have previously added to the .gitignore. The gitignore must not become a mechanism for developers to use to prevent their own personal scratch or temporary files from making it to Github, as this will muddy the intent of the document for other developers in the future.

Once you have removed these files and made a commit, you can create a temporary directory for files you need to work on this task but don't want to commit to the main repo. When you run your git add command, you can exclude this directory by prefixing it with a colon and a caret. Something like this:

git add . :^phillips-personal-temp-directory

I also noticed that you have two copies of Home.md. Please keep the one in the wiki folder and ensure that this one contains the last revision that you wish to commit.

Thanks in advance for these changes!

[dvorakjt]

Hi Phillip,

This is getting better, good job!

A few points:

• I don't think we want to delete the style guide and contributing files just yet. Let's wait until these have been incorporated into the wiki.
• Could you please format the both files a bit? When the markdown is rendered, it will look fine as it is, but looking at the raw code, I would appreciate 1 line of vertical space before and after headings (except the very first heading, which of course only needs an empty line after it). Also, I would remove extra new lines at the end.
• Could you please rename "How to setup your local development environment" to simply "Getting Started" ?
• In "Getting Started," there are a few things that need clarification:
  • Running npm install installs all dependencies, not just Next.js.
  • VSCode offers several advantages for working with TypeScript, including intellisense, type-checking, and easy refactoring. These features provide immediate feedback when developers introduce errors and make it easy to refactor code for accuracy and clarity. We have had issues with developers using other editors: type-errors were not caught and had to be addressed at the PR review stage when they could have been noticed sooner and fixed before a second set of eyes ever took a look at the code. Therefore, it would be nice to mention these advantages so as to steer developers towards VSCode. Another option that offers similar features is WebStorm from JetBrains. These are the two code editors/IDEs that I can recommend.
  • When devs clone the project, the package.json is cloned with it. This file already contains all of the commands necessary to run the project, so there is no need to edit it unless a developer is introducing a new feature. Therefore, step 4 can be removed.
  • Keep in mind, not all devs will be using Windows. I would be less specific about how to install Docker, and instead direct them to Docker's own documentation, saying something like "refer to the Docker installation instructions for your operating system."
• There are other requirements besides Docker and Node. We also need Python 3 for the end-to-end tests.
• A .env file must be created, following the .env.example file.

Keep up the great work, this is much better already!

[dvorakjt]

Looks good! Just get your fork up to date with the upstream repo and we can merge