Merge branch 'main' of github.com:thewca/web-dev-docs

Author: dunkOnIT

contributing/detailed_contributing_guide.md

@@ -27,7 +27,14 @@ This is an essential step of contributing to the WCA website, as you'll want to
 6. If you're using Visual Studio Code to develop, you can [attach it to the Docker container](https://code.visualstudio.com/docs/remote/containers) so that your extensions can take advantage of the Ruby environment and so the terminal runs from inside the container
 
 ### 3. Set up the database
-TODO
+
+#### Import the developer database
+1. Make sure that you have allocated at least 4GB RAM to your Docker containers under the Resources menu.
+2. In a bin/rails console prompt, run `bin/rake db:load:development`
+3. This job will take 10-200 minutes - yes, more than two hours in bad cases! This will load the latest database export onto your local machine.
+
+#### Run CAD 
+In a bin/rails console prompt, run `ComputeAuxiliaryData.perform_now`.
 
 ### 4. Run migrations (if necesary)
 

contributing/quickstart.md

@@ -18,8 +18,8 @@ Now the website will run locally. You have some options on how to set up the dat
 
 ## (2) DATABASE SETUP
 There are two options here - a "test" database with generated data, or the production database (with sensitive information removed).
-1. **Test database**: Quick to set up, but may not mirror real-world data well. `bin/rake db:reset`
-2. **Exported database**: Takes 60-90 minutes to set up, but uses actual data from the live website. `bin/rake db:load:development`
+1. **Test database**: Quick to set up, but may not mirror real-world data well. `docker exec -it rails bash -c "bin/rake db:reset"`
+2. **Exported database**: Takes 60-90 minutes to set up, but uses actual data from the live website. `docker exec -it rails bash -c "bin/rake db:load:development"`
 
 ## (3) RUNNING TESTS
 Two options - running while your docker server is running, or running tests independently. 

guides/translating_the_website.md

@@ -174,7 +174,7 @@ Here are the descriptions of the field:
 1. The name of your translation, anything really
 2. The base locale code, in our case it will always be "en".
 3. The locale code for the language you're translating (see [here](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), the "639-1" column). It may be completed if your language is based on another one (eg: "pt" is used for Portuguese, "pt-BR" is used for Brazilian Portuguese).
-4. The url of the file you're translating, in our case we use "https://raw.githubusercontent.com/thewca/worldcubeassociation.org/master/WcaOnRails/config/locales/en.yml" as it will always point to the most up-to-date version of the English locale.
+4. The url of the file you're translating, in our case we use "https://raw.githubusercontent.com/thewca/worldcubeassociation.org/main/config/locales/en.yml" as it will always point to the most up-to-date version of the English locale.
 5. The url of the locale file in the target language. If your language doesn't exist yet on the website **leave it empty**! If you're updating an existing translation, you can import the work done until now by specifying the locale url (change "en" by your locale code in the link used for 4).
 6. If the generated file should contain include hashes of the original keys. **Keep it checked!** It will enable the website to display accurate information about the translation status in the [translations status](https://www.worldcubeassociation.org/translations/status) page :)
 
@@ -256,7 +256,7 @@ Some of the content is provided by external modules (such as some error messages
 If you don't plan on opening a PR, please skip the next information and we'll be happy to do this for you!
 
 Here is where you can get the additional modules' translation:
- - `time_will_tell`: it's the component used to display date ranges, such as on the competitions index page. There is no locale available, so if you want to translate these too, you need to take [this](https://github.com/thewca/worldcubeassociation.org/blob/master/WcaOnRails/config/locales/time_will_tell.en.yml) file, translate it, and include the translation in your PR.
+ - `time_will_tell`: it's the component used to display date ranges, such as on the competitions index page. There is no locale available, so if you want to translate these too, you need to take [this](https://github.com/thewca/worldcubeassociation.org/blob/main/config/locales/time_will_tell.en.yml) file, translate it, and include the translation in your PR.
  - `carrierwave`: it's the tool used to update profile pictures. There are plenty of locales already available [here](https://github.com/carrierwaveuploader/carrierwave-i18n/blob/3046d86ef580d449ea6ad70aab05db22276da01c/rails/locales). Pick the one for your language, edit the key names containing "whitelist" or "blacklist" to "white_list" or "black_list" (respectively), and include it in your PR.
  - `momentjs`: it's the component used to display a calendar when one has to fill in a date. Here again plenty of locales are available, so you just need to activate your language in [this](https://github.com/thewca/worldcubeassociation.org/blob/34d46d3f0ed022ec20a84d6d6241853f05495b71/WcaOnRails/app/assets/javascripts/application.js#L27-L28) file (just as I did with the French one).