Merge pull request #694 from Klimatbyran/staging

Feat/update docs (#663)

README.md

@@ -74,7 +74,7 @@ Looking for ideas on what needs to be done? We appreciate help on existing [issu
 
 Testing, bug fixes, typos or fact checking of our data is highly appreciated.
 
-See [doc/contributing.md] before making your first contribution.
+See [doc/contributing.md](./doc/contributing.md) before making your first contribution.
 
 ## Contact
 

doc/contributing.md

@@ -26,7 +26,7 @@ Once you decide to pick an issue up, leave a comment saying so, to avoid others
 
 ### Step 3. Make your changes
 
-For most issues you will start with making sure you can run Klimatkollen locally, see [doc/getting-started.md] for instructions on that. 
+For most issues you will start with making sure you can run Klimatkollen locally, see [doc/getting-started.md](./getting-started.md) for instructions on that, and how to set up your dev environment. 
 
 Run `git log -1` to see the latest commit in your local repo, and make sure this is the same as the `staging` branch on GitHub. This is to make sure you are up to date on everyone's changes. 
 
@@ -54,7 +54,7 @@ Push your commits to your fork of Klimatkollen. If you haven't created a fork al
 
 Create a pull request. Either follow the link git showed after pushing to your fork, or create it from the GitHub web interface. Double check the branches in the PR! Make sure your are merging from your own branch, on your own repo, into "staging" on "klimatkollen". A common mistake is to accidentally start merging into "staging" on your own repo.
 
-In the PR desscription, write "Fixes #XXX" where XXX is the id of the issue you are fixing. E.g. `Fixes #413`
+In the PR description, write "Fixes #XXX" where XXX is the id of the issue you are fixing. E.g. `Fixes #413`
 
 If the PR is not ready for review yet, prefix the title wiht "Draft: ". Remove this once you're ready.
 
@@ -68,7 +68,7 @@ The reviewer will most likely have some comments, questions, or feedback, which
 
 In some cases, the reviewer might make some changes to your PR themselves and commit it, if they need to get the fix in quickly. 
 
-The reviewer might also conclude that the changes should not be made, or that there currently isn't time to review it. Such a scenario is unlikely but if it does happen, please be understanding and remember that the reviwer wants what's best for the project, just like you.
+The reviewer might also conclude that the changes should not be made, or that there currently isn't time to review it. Such a scenario is unlikely but if it does happen, please be understanding and remember that the reviewer wants what's best for the project, just like you.
 
 Klimatkollen's team has the final say on what goes into the code. 
 

doc/getting-started.md

@@ -2,24 +2,27 @@
 
 Klimatkollen is for the most part a self-contained web application. This means you can run it on your own computer and see your own copy in your web brower. This page will outline how to do that from scratch. If you haven't done some of these things before, it might feel like a long process before you get to launch the page. Almost all of it is one-time setup, meaning once you get through it, contributing in the future is much easier.
 
+If you're looking to contribute code, some basic knowledge of HTML, CSS and JS is recommended. [freeCodeCamp](https://www.freecodecamp.org/) is a great place to learn these fundamentals.
+
 The steps will be as follows:
 
- * Getting the source code
  * Installing Node.js
+ * Getting the source code
  * Installing other dependencies
+ * Our frontend technologies
  * Running Klimatkollen
 
 If you get stuck at any point, don't hesitate to ask on the Discord which is linked in the main README. Really - we want to help!
 
-## Downloading Node.js
+## Installing Node.js
 
 Klimatkollen is written mostly in JavaScript. To execute JavaScript directly on your computer, you need [Node.js](https://nodejs.org/en). Just press the big "download" button and follow the instructions. After the installation, start a new terminal or command prompt to verify that it went well. You should be able to run the commands "node" and "npm" successfully. Just remember to start a *new* terminal.
 
 ## Getting the source code
 
 Klimatkollen is open source and the source code is hosted on [GitHub](https://github.com/Klimatbyran/klimatkollen). The absolute easiest way to get it is to just press the big green "Code" button on that page and select "Download ZIP". If you don't plan on making any of your own contributions, this is enough and you can skip to the next section.
 
-If you do want to contribute code, or even check out other people's work-in-progress, you will need to use [git](https://git-scm.com/), which is a system that manages source code history and enables collaboration. If you're not faimiliar with git, here are some links that can get you started. Don't feel like you have to spend a lot of time learning git. A basic understanding is enough to get by in most cases.
+If you do want to contribute code, or even check out other people's work-in-progress, you will need to use [git](https://git-scm.com/), which is a system that manages source code history and enables collaboration. If you're not familiar with git, here are some links that can get you started. Don't feel like you have to spend a lot of time learning git. A basic understanding is enough to get by in most cases.
 
  * https://docs.github.com/en/get-started/using-git/about-git
  * https://www.w3schools.com/git/git_intro.asp?remote=github
@@ -43,4 +46,4 @@ The full list is in "package.json" which is a file that npm can understand. To h
 
 ## Running the Klimatkollen webapp. 
 
-If all the dependencies were installed without issues, you should be able to run `npm run dev`. This will de a little slow the first time, but ifeverything goes well it will tell you it is serving the app from "localhost:3000". Type that address in your browser and you should see your local copy of Klimatkollen in its full glory!
+If all the dependencies were installed without issues, you should be able to run `npm run dev`. This will de a little slow the first time, but if everything goes well it will tell you it is serving the app from "localhost:3000". Type that address in your browser and you should see your local copy of Klimatkollen in its full glory!