diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 7363a5f6..a756fd00 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -16,7 +16,7 @@ Want to contribute? Great. Please review the following guidelines carefully and
## Reporting bugs
-1. Update to the most recent master release; the bug may already be fixed.
+1. Update to the most recent main release; the bug may already be fixed.
2. Search for existing issues; it's possible someone has already encountered this bug.
3. Try to isolate the problem and include steps to reproduce it.
4. Share as much information as possible (e.g. browser/OS environment, log output, stack trace, screenshots, etc.).
@@ -44,7 +44,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher
## Contributing new documentations
-See the [`docs` folder](https://github.com/freeCodeCamp/devdocs/tree/master/docs) to learn how to add new documentations.
+See the [`docs` folder](https://github.com/freeCodeCamp/devdocs/tree/main/docs) to learn how to add new documentations.
**Important:** the documentation's license must permit alteration, redistribution and commercial use, and the documented software must be released under an open source license. Feel free to get in touch if you're not sure if a documentation meets those requirements.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 593d59aa..a496a10d 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -19,7 +19,7 @@ Verify this steps before suggeting a new feature:
https://github.com/freeCodeCamp/devdocs/labels/feature
- Make sure your feature fits DevDocs' vision
- https://github.com/freeCodeCamp/devdocs/blob/master/README.md#vision
+ https://github.com/freeCodeCamp/devdocs/blob/main/README.md#vision
-->
## Summary
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5dc7eda4..f8bc6637 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -4,7 +4,7 @@
-
+
If you’re adding a new scraper, please ensure that you have:
@@ -17,7 +17,7 @@ If you’re adding a new scraper, please ensure that you have:
- [ ] `SOURCE`: A text file containing the URL to the page the image can be found on or the URL of the original image itself
-
+
If you're updating an existing documentation to it's latest version, please ensure that you have:
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 1de9ec36..e9248ebe 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -3,7 +3,7 @@ name: Deploy
on:
push:
branches:
- - master
+ - main
jobs:
test:
diff --git a/README.md b/README.md
index b30d3789..35367313 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ Finally, point your browser at [localhost:9292](http://localhost:9292) (the firs
The `thor docs:download` command is used to download pre-generated documentations from DevDocs's servers (e.g. `thor docs:download html css`). You can see the list of available documentations and versions by running `thor docs:list`. To update all downloaded documentations, run `thor docs:download --installed`. To download and install all documentation this project has available, run `thor docs:download --all`.
-**Note:** there is currently no update mechanism other than `git pull origin master` to update the code and `thor docs:download --installed` to download the latest version of the docs. To stay informed about new releases, be sure to [watch](https://github.com/freeCodeCamp/devdocs/subscription) this repository.
+**Note:** there is currently no update mechanism other than `git pull origin main` to update the code and `thor docs:download --installed` to download the latest version of the docs. To stay informed about new releases, be sure to [watch](https://github.com/freeCodeCamp/devdocs/subscription) this repository.
Alternatively, DevDocs may be started as a Docker container:
diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee
index 07956a50..93972075 100644
--- a/assets/javascripts/templates/pages/about_tmpl.coffee
+++ b/assets/javascripts/templates/pages/about_tmpl.coffee
@@ -25,8 +25,8 @@ app.templates.aboutPage = -> """
Copyright 2013–2021 Thibaut Courouble and other contributors
This software is licensed under the terms of the Mozilla Public License v2.0.
You may obtain a copy of the source code at github.com/freeCodeCamp/devdocs.
- For more information, see the COPYRIGHT
- and LICENSE files.
+ For more information, see the COPYRIGHT
+ and LICENSE files.
Happy coding! diff --git a/docs/filter-reference.md b/docs/filter-reference.md index 6c138771..fcd552d2 100644 --- a/docs/filter-reference.md +++ b/docs/filter-reference.md @@ -11,7 +11,7 @@ Filters use the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. They take an HTML string or [Nokogiri](http://nokogiri.org/) node as input, optionally perform modifications and/or extract information from it, and then outputs the result. Together they form a pipeline where each filter hands its output to the next filter's input. Every documentation page passes through this pipeline before being copied on the local filesystem. -Filters are subclasses of the [`Docs::Filter`](https://github.com/freeCodeCamp/devdocs/blob/master/lib/docs/core/filter.rb) class and require a `call` method. A basic implementation looks like this: +Filters are subclasses of the [`Docs::Filter`](https://github.com/freeCodeCamp/devdocs/blob/main/lib/docs/core/filter.rb) class and require a `call` method. A basic implementation looks like this: ```ruby module Docs @@ -46,7 +46,7 @@ The `call` method must return either `doc` or `html`, depending on the type of f - `:path` — the page's normalized path - `:store_path` — the path where the page will be stored (equal to `:path` with `.html` at the end) - `:internal_urls` — the list of distinct internal URLs found within the page - - `:entries` — the [`Entry`](https://github.com/freeCodeCamp/devdocs/blob/master/lib/docs/core/models/entry.rb) objects to add to the index + - `:entries` — the [`Entry`](https://github.com/freeCodeCamp/devdocs/blob/main/lib/docs/core/models/entry.rb) objects to add to the index * `css`, `at_css`, `xpath`, `at_xpath` Shortcuts for `doc.css`, `doc.xpath`, etc. @@ -73,23 +73,23 @@ The `call` method must return either `doc` or `html`, depending on the type of f ## Core filters -* [`ContainerFilter`](https://github.com/freeCodeCamp/devdocs/blob/master/lib/docs/filters/core/container.rb) — changes the root node of the document (remove everything outside) -* [`CleanHtmlFilter`](https://github.com/freeCodeCamp/devdocs/blob/master/lib/docs/filters/core/clean_html.rb) — removes HTML comments, `