From 4d9375ca739df44ef52cd026de9a20aaff60d9aa Mon Sep 17 00:00:00 2001 From: Brian Thomas Smith Date: Wed, 27 Mar 2024 15:08:59 +0100 Subject: [PATCH 001/205] fix: normalize capitalization for GitHub and TypeScript (#32840) chore: normalize capitalization for GitHub and TypeScript --- files/en-us/learn/server-side/django/deployment/index.md | 2 +- .../server-side/django/development_environment/index.md | 8 ++++---- .../learn/server-side/django/skeleton_website/index.md | 6 +++--- .../learn/server-side/express_nodejs/deployment/index.md | 2 +- .../angular_item_component/index.md | 2 +- .../angular_todo_list_beginning/index.md | 2 +- .../svelte_typescript/index.md | 2 +- .../managing_and_resolving_discussions/index.md | 2 +- .../mdn/writing_guidelines/page_structures/links/index.md | 2 +- .../writing_guidelines/page_structures/sidebars/index.md | 4 ++-- 10 files changed, 16 insertions(+), 16 deletions(-) diff --git a/files/en-us/learn/server-side/django/deployment/index.md b/files/en-us/learn/server-side/django/deployment/index.md index dd9dab878a464e8..9a79046b4dd8c8a 100644 --- a/files/en-us/learn/server-side/django/deployment/index.md +++ b/files/en-us/learn/server-side/django/deployment/index.md @@ -437,7 +437,7 @@ To start using PythonAnywhere you will first need to create an account: ### Install library from GitHub -Next we're going open a Bash prompt, set up a virtual environment, and fetch the local library source code from Github. +Next we're going open a Bash prompt, set up a virtual environment, and fetch the local library source code from GitHub. We'll also configure the default database and collect static files so that they can be served by PythonAnywhere. 1. First open the Console management screen by selecting **Consoles** in the top application bar. diff --git a/files/en-us/learn/server-side/django/development_environment/index.md b/files/en-us/learn/server-side/django/development_environment/index.md index 360ee39a5f499e5..5dd136576d55c7f 100644 --- a/files/en-us/learn/server-side/django/development_environment/index.md +++ b/files/en-us/learn/server-side/django/development_environment/index.md @@ -391,7 +391,7 @@ py -3 -m django --version Source Code Management (SCM) and versioning tools allow you to reliably store and recover versions of your source code, try out changes, and share code between your experiments and "known good code" when you need to. There are many different SCM tools, including git, Mercurial, Perforce, SVN (Subversion), CVS (Concurrent Versions System), etc., and cloud SCM hosting sources such as Bitbucket, GitHub, and GitLab. -For this tutorial we'll hosting our code on [GitHub](https://github.com/), one of the most popular cloud based source code hosting services, and using the **git** tool to manage our source code locally and send it to Github when needed. +For this tutorial we'll hosting our code on [GitHub](https://github.com/), one of the most popular cloud based source code hosting services, and using the **git** tool to manage our source code locally and send it to GitHub when needed. > **Note:** Using SCM tools is good software development practice! > Ths instructions provide a basic introduction to git and GitHub. @@ -399,7 +399,7 @@ For this tutorial we'll hosting our code on [GitHub](https://github.com/), one o ### Key concepts -Git (and Github) use repositories ("repos") as the top level "bucket" for storing code, where each repo normally contains the source code for just one application or module. +Git (and GitHub) use repositories ("repos") as the top level "bucket" for storing code, where each repo normally contains the source code for just one application or module. Repositories can be public, in which case the code is visible to everyone on the internet, or private, in which case they are restricted to the owning organization or user account. All work is done on a particular "branch" of code in your repo. @@ -529,7 +529,7 @@ This is a useful change to make, but mostly we're doing it to show you how to pu ``` 7. At this point, the remote repo has not been changed. - We can push the `update_gitignore` branch to the "origin" repo (Github) using the following command: + We can push the `update_gitignore` branch to the "origin" repo (GitHub) using the following command: ```bash git push origin update_gitignore @@ -542,7 +542,7 @@ This is a useful change to make, but mostly we're doing it to show you how to pu ![Banner asking if user wants to compare and merge recent branch updates](github_compare_and_pull_banner.png) - After merging, the "main" branch on the repo on Github will contain your changes to `.gitignore`. + After merging, the "main" branch on the repo on GitHub will contain your changes to `.gitignore`. 9. You can continue to update your local repo as files change using this add/commit/push cycle. diff --git a/files/en-us/learn/server-side/django/skeleton_website/index.md b/files/en-us/learn/server-side/django/skeleton_website/index.md index 2e3ceb3765c3a3c..dbb649b5504637f 100644 --- a/files/en-us/learn/server-side/django/skeleton_website/index.md +++ b/files/en-us/learn/server-side/django/skeleton_website/index.md @@ -58,7 +58,7 @@ At the end of this article, we discuss other site-wide configuration you might a To create the project: 1. Open a command shell (or a terminal window), and make sure you are in your [virtual environment](/en-US/docs/Learn/Server-side/Django/development_environment#using_a_virtual_environment). -2. Navigate to the folder where you want to create your local library application (later on we'll move it to the "django_local_library" that you [created as a local Github repository](/en-US/docs/Learn/Server-side/Django/development_environment#clone_the_repo_to_your_local_computer) when setting up the development environment). +2. Navigate to the folder where you want to create your local library application (later on we'll move it to the "django_local_library" that you [created as a local GitHub repository](/en-US/docs/Learn/Server-side/Django/development_environment#clone_the_repo_to_your_local_computer) when setting up the development environment). 3. Create the new project using the `django-admin startproject` command as shown, and then navigate into the project folder: ```bash @@ -336,11 +336,11 @@ At this point, we know that Django is working! > **Note:** The example page demonstrates a great Django feature — automated debug logging. Whenever a page cannot be found, Django displays an error screen with useful information or any error raised by the code. In this case, we can see that the URL we've supplied doesn't match any of our URL patterns (as listed). Logging is turned off in production (which is when we put the site live on the Web), in which case a less informative but more user-friendly page will be served. -## Don't forget to backup to Github +## Don't forget to backup to GitHub We've just done some significant work, so now is a good time to backup the project using GitHub. -First move the _content_ of the top level **locallibrary** folder into the **django_local_library** folder that you [created as a local Github repository](/en-US/docs/Learn/Server-side/Django/development_environment#clone_the_repo_to_your_local_computer) when setting up the development environment. +First move the _content_ of the top level **locallibrary** folder into the **django_local_library** folder that you [created as a local GitHub repository](/en-US/docs/Learn/Server-side/Django/development_environment#clone_the_repo_to_your_local_computer) when setting up the development environment. This will include **manage.py**, the **locallibrary** subfolder, the **catalog** subfolder, and anything else inside the top level folder. Then add and commit the changes in the **django_local_library** folder and push them to GitHub. diff --git a/files/en-us/learn/server-side/express_nodejs/deployment/index.md b/files/en-us/learn/server-side/express_nodejs/deployment/index.md index 29a27a91a481823..53c8337d31e4897 100644 --- a/files/en-us/learn/server-side/express_nodejs/deployment/index.md +++ b/files/en-us/learn/server-side/express_nodejs/deployment/index.md @@ -487,7 +487,7 @@ Note that the variables are _secret_: the `.env` should not be included in your The Glitch editing view also provides _terminal_ access to the web app environment, which you can use to work with the web app as though it was running on your local machine. That's all the overview you need to get started. -Next, we will set up a Glitch account, upload the Library project from Github, and connect it to a database. +Next, we will set up a Glitch account, upload the Library project from GitHub, and connect it to a database. ### Get a Glitch account diff --git a/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/angular_item_component/index.md b/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/angular_item_component/index.md index 9120b4577f99f9f..b581a394d1a2b86 100644 --- a/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/angular_item_component/index.md +++ b/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/angular_item_component/index.md @@ -240,7 +240,7 @@ When you use a property in the template, you must also declare it in the class. An `@Input()` serves as a doorway for data to come into the component, and an `@Output()` acts as a doorway for data to go out of the component. An `@Output()` has to be of type `EventEmitter`, so that a component can raise an event when there's data ready to share with another component. -> **Note:** The `!` in the class's property declaration is called a [definite assignment assertion](https://www.typescriptlang.org/docs/handbook/2/classes.html#--strictpropertyinitialization). This operator tells Typescript that the `item` field is always initialized and not `undefined`, even when TypeScript cannot tell from the constructor's definition. If this operator is not included in your code and you have strict TypeScript compilation settings, the app will fail to compile. +> **Note:** The `!` in the class's property declaration is called a [definite assignment assertion](https://www.typescriptlang.org/docs/handbook/2/classes.html#--strictpropertyinitialization). This operator tells TypeScript that the `item` field is always initialized and not `undefined`, even when TypeScript cannot tell from the constructor's definition. If this operator is not included in your code and you have strict TypeScript compilation settings, the app will fail to compile. Use `@Input()` to specify that the value of a property can come from outside of the component. Use `@Output()` in conjunction with `EventEmitter` to specify that the value of a property can leave the component so that another component can receive that data. diff --git a/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/angular_todo_list_beginning/index.md b/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/angular_todo_list_beginning/index.md index 6b3c478f5e4f967..682704537303847 100644 --- a/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/angular_todo_list_beginning/index.md +++ b/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/angular_todo_list_beginning/index.md @@ -60,7 +60,7 @@ Components are a central building block of Angular applications. This to-do application has two components — a component as a foundation for your application, and a component for handling to-do items. Each component is made up of a TypeScript class, HTML, and CSS. -TypeScript transpiles, or converts, into JavaScript, which means that your application ultimately ends up in plain JavaScript but you have the convenience of using Typescript's extended features and streamlined syntax. +TypeScript transpiles, or converts, into JavaScript, which means that your application ultimately ends up in plain JavaScript but you have the convenience of using TypeScript's extended features and streamlined syntax. ### Dynamically change the UI with \*ngIf and \*ngFor diff --git a/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/svelte_typescript/index.md b/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/svelte_typescript/index.md index a8f92fcc90d0bbb..a288b7296fea12a 100644 --- a/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/svelte_typescript/index.md +++ b/files/en-us/learn/tools_and_testing/client-side_javascript_frameworks/svelte_typescript/index.md @@ -163,7 +163,7 @@ As we said before, TypeScript is a superset of JavaScript, so your application w Once you have TypeScript configured, you can start using it from a Svelte component by just adding a `