Commit graph

462 commits

Author SHA1 Message Date
Fyodor
55b0224d78
Fix PropTypes folder path typo in documentation for Preact (#14505)
* Fix PropTypes folder path typo in documentation for Preact

* Fix PropTypes folder path typo in documentation for Preact

* Rollback unnecessary text update
2021-08-16 09:59:14 +02:00
zeotuan
6d45399a80
extend documentation on how to run cypres on wsl2 (#14393)
* fix analytic page have no back-to-dashboard button when user have no organization

* resolve conflict with main

* remove dump

* add test for back to dashboard button

* extend doc for windows installation

* remove unrelated file (fix checkout from wrong branch)

* Fix typo

Co-authored-by: rhymes <github@rhymes.dev>

* Fix typo

Co-authored-by: rhymes <github@rhymes.dev>

* Fix typo

Co-authored-by: rhymes <github@rhymes.dev>

Co-authored-by: rhymes <github@rhymes.dev>
2021-08-04 11:20:02 -06:00
Fernando Valverde
e73afa22c7
Take Apple Authentication out of Beta (#12114)
* Removing :apple_auth feature flag and debugging

* Fix tests failing due to nil in Devise initializer

* Remove db/schema.rb changes

* Devise config tweak

* cleaning up

* Fix spec + delete debug logs

* Removes temporary beta_access_providers spec + remove feature flag DUS

* Add test to avoid connecting an existing user with SIWA

* Fix merge conflict mistake + more feature flag cleanups
2021-08-03 15:04:00 -06:00
Ridhwana
e827b8bab9
Minimal Seed Data for Admin Onboarding (#14385)
* minimal seeded flows

* fix: remove mistake

* refactor: rename the files appropriately

* feat: change some text

* fix: typo

* chore: new commit to rebuild
2021-07-29 17:08:41 +02:00
Nick Taylor
9303e1f071
[15 min fix] Added support for the --no-seed argument to bin/e2e command (#14307) 2021-07-22 17:04:18 -04:00
Ben Halpern
94171f0cfb
Update docs on self-host page (#14290)
* Update copy on self-host page of docs

* Update copy on self-host page of docs
2021-07-20 17:31:10 -04:00
Suzanne Aitchison
dcab661070
add to E2E docs (#14149) 2021-07-07 09:18:11 +01:00
okyanusoz
c0dd9dc40e
Update imgproxy.md (#14084) 2021-06-28 09:10:36 -05:00
rhymes
d018b69106
API: Remove Admin Config endpoint (#13934) 2021-06-08 09:43:51 +02:00
Ineza Bonté Grévy
802a557399
Update api docs to include list of events for creating webhooks (#13849) 2021-05-25 10:03:06 -05:00
Michael Kohl
6dfabd578f
Rename SiteConfig to Settings::General (#13573)
* Rename SiteConfig

* More renaming

* Update spec

* Update mandatory settings mapping

* More renaming

* e2e test fixes

* You have a rename, and you have a rename

* Spec fix

* More changes

* Temporarily disable specs

* After-merge update

* Undo rename for migration

* undo rename of DUS

* Fix DUS

* Fix merge problem

* Remove redundant DUS

* Fix specs

* Remove unused code

* Change wrong class name

* More cleanup

* Re-add missing values to constant

* Fix constant

* Fix spec

* Remove obsolete fields

* Add accidentally removed field

* Update spec

* Move methods from Settings::General to ForemInstance

* Remove unneeded model

* Change mentions of 'site config'
2021-05-21 14:45:37 +02:00
Andrew Bone
ba5e55ae44
Update rbenv-doctor location in docs (#13803)
* Update with best practices

* Remove useCallback

* Update app/javascript/shared/components/useKeyboardShortcuts.js

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>

* Fill out JSDoc

* Follow Prettier rules

* Resolve conflict

* 📝 Update rbenv-doctor location

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
2021-05-19 08:59:22 -06:00
Karel De Smet
302ccee8e4
Fix typo: 'upsteam' -> 'upstream' (#13771) 2021-05-17 11:09:44 +07:00
Madza
cac7fd1c55
Update GitPod setup description (#13709) 2021-05-12 10:30:42 +02:00
Ridhwana
449723d8c7
[15-min-fix] Remove/Update the last of the admin hardcoded paths (#13681)
* chore: hardcoded paths

* hardcoded docs path

* Update docs/admin/admin-search.md

Co-authored-by: rhymes <github@rhymes.dev>

Co-authored-by: rhymes <github@rhymes.dev>
2021-05-06 15:12:06 +02:00
Fernando Valverde
121603a44b
Replace Pusher Beams with Rpush PN delivery ✂️ ✂️ (#13588)
* Remove feature flag

* Remove Pusher Beams implementation

* Remove Pusher Beams require from initializer

* Adds consumer apps to sidebar + consider :admin_restructure

* Fix routes + PN target URL

* Remove old file that sneaked in

* Adds docs

* docs tweaks

* Apply suggestions from code review

Co-authored-by: rhymes <rhymes@hey.com>

Co-authored-by: rhymes <rhymes@hey.com>
2021-05-05 08:37:20 -06:00
Mac Siri
25f6b3e9ed
Convert SMTP configs into environments vars (#13542)
Co-authored-by: rhymes <rhymes@hey.com>
2021-05-03 16:32:15 -04:00
Alex
393ba00221
Remove Elasticsearch ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ (#13606)
* Attempt number 1

* Fix rack_attack specs

* Fix users_searches_users spec

* Fix display_users_search_spec

* Fix comment typo

* Remove search:destroy task from cypress

* Remove port 9300 from gitpod

* Stub response in attack_spec
2021-05-03 11:09:45 -04:00
Michael Kohl
28dd50e718
Create settings model for rate limits (#13381)
Co-authored-by: rhymes <rhymes@hey.com>
2021-04-20 11:29:22 +07:00
Daniel Uber
2f1dad4e37
Add reading_time to articles api responses (#13446)
* Add reading_time to articles api responses

Fixes #13436

* Update api docs to match changes to the articles response

* Follow up docs updates

- increment api docs version
- add reading_time to articles/me responses
- add reading time to the show response example format

* Change reading_time attribute to reading_time_minutes

Update the article builder to use `article.reading_time` and present
it as `"reading_time_minutes"`.

Update the api spec to expect the new property name instead of the attribute.

* Update api documentation to reflect the new name

- Change reading_time -> reading_time_minutes.
- I decided to keep the (possibly redundant) description text here.
2021-04-19 17:11:55 -05:00
rhymes
f5691dbb5e
[15 min fix] Document data update scripts best practices (#13432)
* Add data update scripts best practices

* Remove leftover counter
2021-04-19 16:11:10 +02:00
Josh Puetz
9fe7be190b
Switch references to Forem master branch to main (#12325) 2021-04-16 11:51:06 -05:00
Suzanne Aitchison
65f558e4f2
add some notes re manual testing in pr template and docs (#13414) 2021-04-15 15:03:06 +01:00
rhymes
5221a26bff
API docs: rename deprecated code samples extension (#13375) 2021-04-13 16:15:18 +02:00
Michael Kohl
d1c3380161
Update GET /followers API endpoint (#13287)
* Add created_at to API followers controller

* Add sorting

* Update API docs

* Update app/controllers/api/v0/followers_controller.rb

Co-authored-by: Jamie Gaskins <jgaskins@gmail.com>

* Update app/controllers/api/v0/followers_controller.rb

Co-authored-by: Jamie Gaskins <jgaskins@gmail.com>

* Use correct date format

* Update API docs

* Add JsonApiSortParams concern

* Update controller to use concern

* Rename and add docs

* Update API docs

* Remove leftover file

* Undo gem changes

* Consistently use field vs param

* Reset vendor/cache for git dependencies

Co-authored-by: Jamie Gaskins <jgaskins@gmail.com>
2021-04-13 10:12:42 +07:00
Daniel Uber
77273267b7
Change file name to remove ERB suffix (#13237)
We moved the initializePage.js file from ERB to pure/plain js in
https://github.com/forem/forem/pull/8030, and the docs are out of sync
with the code.

Fix up the path to this file so it matches the codebase.
2021-04-03 18:50:11 -05:00
Jacob Herrington
18ce0c635c
Add endpoint for articles sorted by published date (#13137) 2021-04-01 13:36:36 -05:00
Jacob Herrington
a360d01c37
Make docs reflect code more accurately (#13219) 2021-04-01 08:21:34 -05:00
Vaidehi Joshi
95055b2a89
Remove pro role + expose analytics to all users via dashboard (#13156)
* Remove pro role on user, expose pro dashboard to all users as analytics

* Remove pro from Elasticsearch mappings

* Update user role docs to use :trusted over :pro

* Remove pro from Role model spec

* Remove more references to pro, as noted by @rhymes
2021-03-30 15:02:18 -07:00
Molly Struve
2534a8aa5f
Doc Update:Remove no longer used tech from overview docs (#13192) 2021-03-30 16:41:38 -05:00
Nick Taylor
d23a5a82e7
[15 Min Fix] Added the custom Cypress command, createResponseTemplate, to create comment templates. (#13167)
Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
2021-03-29 12:39:45 -04:00
Nick Taylor
d85d327c1d
[15 minute fix] Added custom Cypress command to create an article. (#13151) 2021-03-29 06:00:49 -04:00
Vaidehi Joshi
3f6600541e
✂️ Remove the approvals gem ✂️ (#12978)
* Remove approvals fixtures

* Remove approvals initializer

* Remove approvals gem

* Remove approvals step from travis.yml

* Remove approvals from dockerignore and gitignore

* Remove references to approvals gem in docs

* Un-approvals spec/liquid_tags/codepen_tag_spec.rb

* Un-approvals spec/liquid_tags/dotnet_fiddle_tag_spec.rb

* Temporarily skip other approvals tests

We will still need to delete files in /spec/fixtures/approvals after this.

* Revert changes to dotnet_fiddle_tag_spec and codepen_tag_spec, skip those tests instead

* Temporarily skip more approvals based tests

* Attempt at moving html doc inline

* Comment out one more approvals spec

* Update dotnet fiddle and codepen liquid tag specs to not use Approvals

* Update liquid tag specs + system specs to not use Approvals

* Un-approval feed import, github issue, and tweet tag specs

* Re-add .approvals to gitignore and dockerignore

* Use Rspec compound expectations
2021-03-19 13:28:06 -07:00
Nick Taylor
7c1343be9e
Revert "Revert "Removed service worker (#12974)" (#13014)" (#13015)
This reverts commit 2416387fb4.
2021-03-17 10:57:56 -04:00
Molly Struve
2416387fb4
Revert "Removed service worker (#12974)" (#13014)
This reverts commit 4fb6230606.
2021-03-16 18:10:01 -05:00
Nick Taylor
4fb6230606
Removed service worker (#12974) 2021-03-16 15:55:31 -04:00
Rafi
dd63fe2bfe
Adding note about crayons design system in forem docs (#12838)
* Adding not about crayon in docs

* Update docs/frontend/styles.md

Co-authored-by: ludwiczakpawel <ludwiczakpawel@gmail.com>

* Fixing wording

* Adding colon

Co-authored-by: Michael Kohl <me@citizen428.net>
Co-authored-by: ludwiczakpawel <ludwiczakpawel@gmail.com>
2021-03-09 10:50:14 -06:00
Daniel Uber
6853edde57
Update style guide link (#12876) 2021-03-03 11:39:05 +07:00
Jacob Herrington
92217be4ed
Add admin overview page (#12726)
* Add admin overview page

* Rename admin_portals spec

* Fix admin nav bug

* Add ahoy tracking to admin overview

* Fix PR Feedback

Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>

* Make decorative element more visible

* Remove inline layout styles

Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2021-03-01 18:59:05 -06:00
Ben Halpern
73125c0795
Reduce service worker functionality to minimal offline page (#12834)
* Reduce service worker functionality to minimal offline page

* Update docs for service workers

* Add comment to fix test

* Include incrementable static cache

* Add TODO comments about removal

* Fix trailing whitespace
2021-03-01 19:29:26 -05:00
Andy Zhao
1fd0ec4041
Try yarn instead over npm for storybook deploys (#12376)
* Try yarn instead over npm

* Remove ignore flag and use default flag

* Add yarn version

* Remove --docs

* Use NPM :( we don't have a yarn.lock in app/javascript

* Use NPM :( we don't have a yarn.lock in app/javascript

* Updated base to root to use yarn

* hack the command with cd 🙃

* debuggng

* copy package.json and yarn.lock from root

* Set flag to use yarn explicitly

* Oops

* Try a different way

* Package.json not yarn.lock

* Maybe??

* Install yarn with npm then run yarn install??

* Add a Node version

* Try one more thing...

* Syntax error

* I think it's working...

* nvm it didn't work

* Use any 14.14 node version -- syntax correct maybe?

* Fix broken redirects smh

* Update redirects for storybook

* Remove unnecessary redirect rule

* Trigger notifications

* Trigger notifications

* Remove some unused comments
2021-02-26 10:30:56 -05:00
Nick Taylor
2bba2a6ee4
Added the @components webpack alias to the project (#12808)
* Added the @shared webpack alias to the project.

* Added some documentation.

* Fixed a copy paste error.

* Renamed @shared to @components.

* Update docs/frontend/webpacker.md

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
2021-02-24 16:07:48 +01:00
rhymes
af77a47293
Remove canonical_url from API Article Create/Update examples (#12795) 2021-02-24 10:29:56 +01:00
Ridhwana
07fcbb6f0e
Parenthesis consistency for add_role and remove_role (#12661)
* chore: use consistent code styles for the parenthesis around arguments

* Revert "chore: use consistent code styles for the parenthesis around arguments"

This reverts commit 281c899a5cff0480b182fef45b10ef69979166cb.

* chore: add consistent parenthesis
2021-02-15 20:35:25 +02:00
Christina
bcbeb66c98
Update Ruby Section and Add Additional Error (#12669)
Adding additional information to the Ruby section to help contributors who are not used to Ruby.
Also explicitly stating that the project must be cloned and forked before using rbenv install $(cat .ruby-version)

Also adding a common error Nick and I encountered with a solution.
2021-02-12 10:45:34 -06:00
rhymes
456f13aa20
Add feature flags docs (#12646)
* Fix typo

* Add technical overview on feature flags in docs

* Update docs/technical-overview/feature_flags.md

Co-authored-by: Jacob Herrington <jacobherringtondeveloper@gmail.com>

* Update docs/technical-overview/feature_flags.md

Co-authored-by: Jacob Herrington <jacobherringtondeveloper@gmail.com>

* Update docs/technical-overview/feature_flags.md

Co-authored-by: Ridhwana <Ridhwana.Khan16@gmail.com>

* Update docs/technical-overview/feature_flags.md

Co-authored-by: Ridhwana <Ridhwana.Khan16@gmail.com>

* Incorporate feedback

Co-authored-by: Jacob Herrington <jacobherringtondeveloper@gmail.com>
Co-authored-by: Ridhwana <Ridhwana.Khan16@gmail.com>
2021-02-11 12:46:46 +01:00
Rachael Wright-Munn
8301b9f667
The GitHub authentication docs did not include the OAuth url. It has been added and the screenshot updated. (#12598) 2021-02-10 10:47:26 -06:00
Jacob Herrington
8a5db7b877
Fix broken doc links (#12615) 2021-02-09 08:20:14 -06:00
Nick Taylor
a56fef9f7c
Documentation for End to End Testing (#12459)
Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
2021-02-05 10:23:10 -05:00
Jacob Herrington
a92681a4ad
Add a tip for the SKIP_SERVICEWORKERS env variable (#12563) 2021-02-04 06:00:55 -06:00