docbrown/docs
Fernando Valverde fcc5c0d2a1
Add Sign in with Apple (#11934)
* Add gem omniauth-apple

* Integrate omniauth-apple

* Integrate callback

* Add fields

* Add tests, fix bugs and make it all work

* Show only enabled providers for the current user

* Add default profile image for Apple

* Remove localhost patch

* Bring over the changed Apple username if the user changes it

* More specs fixed

* Incorporate feedback from PR

* Fix specs

* Simplify code and fix spec

* Fix Broadcast generators to take into account the new provider

* Fix spec

* Generate a truly unique apple_username

* Fix user specs

* Add omniauth-apple-0.0.2 to vendor cache

* Fix merge conflict and spec

* Update VCR fastly sloan cassette

* Revert "Generate a truly unique apple_username"

This reverts commit 2462875575b0bbd6b3c1d56b25afcd3189671608.

* Fix user specs

* Fix specs

* Fix specs

* Hide Connect Apple button behind a feature flag

* Revert "Hide Connect Apple button behind a feature flag"

This reverts commit 105bde0373389a4eb9b6e948f60734c7e0e99cba.

* Fix line lengths

* Fix spec

* ES tag

* CSRF bypass for Apple callback

* custom user_nickname in Apple provider with small tweaks + omniauth-apple bump

* Fixes username specs

* Makes Apple users default image Users::ProfileImageGenerator

* Fallback to mascot_image_url in test environment to avoid breaking Travis

* Fixes Apple CSRF error + makes default nickname more readable

* Trigger Travis

* Better devise config

* Apple SiteConfig entires in /admin/config

* Fixing specs

* Adds beta_access? to Authentication::Providers::Provider

* Fixes specs

* Codeclimate double quote fix in Gemfile

* Fixes /admin/config allowed params & adds feature flag for provider beta_access?

* Remove Enfile & adds temporary docs

* Adds custom apple auth provider settings

* Fix authenticator spec

* Fix configs spec (use last instead of first to avoid apple special case)

* Remove dangling fields from /admin/config

* updates feature flag

* More test fixes

* Hide config behind feature flag too

* omniauth-apple bump

* Takes care of edge case fallback

* Reverse apple_username update

* Adds auth_time to info hash in apple omniauth mock

* Switch to next instead of nesting for feature flag

* Fixes CVE-2015-9284

* Fixes specs after auth providers initiatior refactor from GET to POST

* Spec fixes

* More spec fixes

* Fix Rails codebase reference link

Co-authored-by: rhymes <rhymesete@gmail.com>
Co-authored-by: rhymes <rhymes@hey.com>
2020-12-18 10:22:33 -06:00
..
.static Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
admin Renamed internal.js pack file to admin.js (#11046) 2020-10-23 17:57:39 -04:00
backend Add Sign in with Apple (#11934) 2020-12-18 10:22:33 -06:00
contributing 🚀 Ability to allow tag moderators to create chat channels (#9741) 2020-12-08 13:10:36 +07:00
creators Fix a typo caused by markdown (#9995) 2020-08-25 15:41:59 -04:00
design Add initial language doc page (#9653) 2020-08-06 14:46:04 -04:00
frontend Switch node-sass to dart-sass (#11873) 2020-12-14 22:06:06 -05:00
getting-started Document the advanced startup setup (#11915) 2020-12-16 18:13:57 +01:00
installation Recommend Redis 6 for Forem self installation (#11473) 2020-11-18 17:05:00 +01:00
maintainers Feature:Deploy Forem to DEV on every merge (#11148) 2020-10-30 13:08:16 -05:00
technical-overview Updating navigation (especially mobile) (#10424) 2020-12-08 15:59:21 +01:00
tests Start a11y testing checklist in Forem docs (#11614) 2020-11-25 14:22:50 -05:00
.gitdocs.json Updated gitdocs.json links to https (#11118) 2020-10-27 12:19:03 -04:00
.nvmrc Use Node lts/erbium (v12) for Netlify builds (#5925) 2020-02-06 12:03:11 -05:00
.ruby-version Update to Ruby 2.7.2 (#10594) 2020-11-05 16:11:09 +01:00
api_template.hbs Update docs with Forem instead of dev.to (#9316) 2020-07-15 13:29:11 -04:00
api_v0.yml Add configs/show api for admins (#11358) 2020-12-01 12:22:07 -05:00
faqs.md Add first time admin login to FAQs (#11733) 2020-12-03 11:07:07 -06:00
Gemfile Upgrade Rubocop to 0.81 (#7219) 2020-04-11 10:10:04 +02:00
licensing.md Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
Makefile API: OpenAPI 3 spec and auto generated docs (#3650) 2019-08-12 11:36:04 -04:00
netlify.toml Fix Netlify catch all redirections (#9717) 2020-08-10 13:37:15 -04:00
readme.md Remove confusing line from readme (#11712) 2020-12-03 11:30:31 -06:00
self-hosting.md Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
troubleshooting.md [deploy] Remove ENVied Gem, Use dotenv Take 2 (#9767) 2020-08-14 12:20:47 -05:00

items
technical-overview
installation
getting-started
contributing
backend
frontend
admin
design
tests
faqs.md
troubleshooting.md
licensing.md
self-hosting.md
maintainers
component
Divider
creators

Welcome to Forem's developer documentation

On this site you'll find instructions to setup a local instance of Forem, documentation on the architecture of Forem, how to contribute, and many other useful documents.

This documentation site is the product of a number of volunteer contributors working alongside the Forem Core Team, special thanks to all those who have contributed to the documentation.

Running the documentation locally

Like Forem, this site is open source and the code is hosted on GitHub. If you find any incorrect information, or a even a typo, we'd love to see a pull request.

Forem's documentation is built with GitDocs NodeJS library.

To start the gitdocs server, you should run yarn gitdocs serve from the root of the forem project or from the /docs directory.

yarn gitdocs serve

This will start a server where you can browse the documentation: http://localhost:8000/

If you add new pages or rename existing pages, you'll need to restart the server for those changes to take effect.

Contributing to the docs

If you're looking for more information on contributing, check out the Contributing guide.