Commit graph

369 commits

Author SHA1 Message Date
Michael Kohl
8564c52d9d
Use full path instead of filename for require (#11262) 2020-11-05 08:09:03 +07:00
Michael Kohl
9ad57a8d28
Add --spec option for data_update generator (#11245) 2020-11-03 12:26:08 -05:00
Molly Struve
fbc569b50c
Optimization:Speed Up Notifications Spec By Combining Assertions (#11200) 2020-11-02 07:56:23 -06:00
Spencer
c0168df2a8
API: Endpoint to get an organization's details (#10931)
* add organizations api request spec

* add organizations api controller

* add organizations api show route

* add show jbuilder file

* fix merge conflict on routes

* add organization show to api docs

* update created_at to iso format

* api docs add format field/cleanup
2020-10-30 16:22:30 -04:00
Molly Struve
6e9d7bf00f
Feature:Deploy Forem to DEV on every merge (#11148)
* Feature:Deploy Forem to DEV on every merge

* emphasis in docs

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

Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-10-30 13:08:16 -05:00
ludwiczakpawel
44466532dd
Z-index cleanups (#11157)
* tooltips 1.0.1

* tooltips 1.0.1

* cleanup css

* few more fixes

* fix
2020-10-30 16:03:23 +01:00
Yih Yang
24a4a421e1
removed envied docs (#11160)
* removed envied docs

* updated linux.md and windows.md

* removed envied documentation from windows.md and linux.md
2020-10-30 10:38:38 -04:00
Christina
473c2ccb8d
Removing ElasticSearch Brew instructions (#10370)
* Removing ElasticSearch Brew instructions

If you try to install brew as directed you get this Error:
Error: Calling Installation of elasticsearch-oss from a GitHub commit URL is disabled! Use 'brew extract elasticsearch-oss' to stable tap on GitHub instead.

Brew/ElasticSearch no longer allows you to tap as we previously have suggested in the doc. Also we can no longer grab the 7.5.2 version with brew. 

We have decided to remove the instructions for now until we upgrade ElasticSearch if possible.

* Adding recommended changes. 

Added back line 15 per Nicks recommendation
 (i.e. with rbenv: `rbenv install $(cat .ruby-version)`)

Line 65 
updated to  7.5 or higher for Elasticsearch per Rhymes recommendation
~Forem requires a version of Elasticsearch 7.5 or higher to be running.  We recommend version 7.5.2.~

Line 110 update:
Added back in the Homebrew instructions but updated commands to `install elastic/tap/elasticsearch-oss`

* Updating wording per Molly's suggestion

Updating "to be running " to "run" and adjusting line 64 to "Forem requires Elasticsearch 7.x to run. We recommend version 7.5.2."
2020-10-29 14:25:56 -06:00
Yih Yang
01a57fed8f
fixed docs url (#11161) 2020-10-29 13:11:21 -04:00
WenYu
5a617f7340
Fix backend link (#11152)
Backend guide link currently leads to a Github 404 page. This commit fix the issue and redirects to the correct backend guide link
2020-10-29 10:14:44 -05:00
Mac Siri
540bc1fd84
[deploy] Add Imgproxy docs (#11104)
Co-authored-by: Molly Struve <mollylbs@gmail.com>
Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-10-29 09:03:55 -04:00
Antony Garand
963f4da743
Updated gitdocs.json links to https (#11118) 2020-10-27 12:19:03 -04:00
Nick Taylor
d5dcda6af6
Renamed internal.js pack file to admin.js (#11046) 2020-10-23 17:57:39 -04:00
Ben Halpern
6fac74b741
[deploy] Experiment with the removal of inline critical path css (#11027)
* Experiment with the removal of inline critical path css

* Fix up tests, remove reference to deleted file

* Change docs

* Fix typo
2020-10-22 19:22:28 -04:00
Simon Fish
1c6f82bd13
Document overriding mailer templates (#10574)
* Document overriding mailer templates

* List emails in backend guide index
Issue #9849
2020-10-20 09:56:09 +02:00
Sam
1d741735f5
Fix grammar error in Code Climate (#10935) 2020-10-19 15:04:27 -06:00
Shubhankar Kanchan Gupta
a60c923539
new liquid tag - dotnetfiddle (#10788)
* new liquid tag - dotnetfiddle

* 1. Moved the hack into controller
2. Use URI to check if Widget keyword doesn't exist, then insert Widget using URI

* 1. Fixed tests
2. Updated code to eliminate xss_attacks

* Update app/liquid_tags/dotnet_fiddle_tag.rb to match pr comment

Co-authored-by: Michael Kohl <me@citizen428.net>

Co-authored-by: Michael Kohl <me@citizen428.net>
2020-10-16 14:47:52 -04:00
Alexis Moody
f4a10e4a44
[deploy] Adds a new admin setting for experience levels. (#10870)
* Adds a new admin setting for experience levels.

This is used in the post management UI to determine the range of experience. These values fallback to the ones we currently see in DEV, Total Newbies and Senior Devs. There is also a removal of the word coding when talking about experience level, since the context for each forem instance should be implied when referencing experience.

* Cleans up experience defaults

* Fixes instance_of usage
2020-10-16 12:40:25 -06:00
Shubhankar Kanchan Gupta
fccb866903
Add rails dbconsole (#10861)
* Add rails dbconsole

* Transfer note at bottom of steps as in PR comment
2020-10-16 14:13:57 -04:00
Alex
0cd1319df2
Update feed docs (#10881)
* Update feed docs

* Update README for typos and clarity

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

* Update feed style summary line

Co-authored-by: Jacob Herrington <jacobherringtondeveloper@gmail.com>
2020-10-16 12:51:52 -04:00
Karin Hendrikse
270c044698
replace Envfile with env_sample and reference env file in auth docs (#10864)
Co-authored-by: khendrikse <k.hendrikse@youngcapital.nl>
2020-10-16 00:09:16 -05:00
Nick Taylor
32825f001f
Fixed documentation and command for adding credits to a user's account for local development. (#10835) 2020-10-14 23:48:54 -04:00
Diogo Osório
2b72a35d3d
[deploy] Introduce /api/profile_images/:username endpoint (#10547)
* Documents the new /profile-images/:username API endpoint

* Introduces the /api/profile_images/:username endpoint

This endpoint receives either an user or organization username as input
via the URL path and returns the profile image information for that
user/orgnization.

* Updates the /api/profile_images/:username response

Adapts the response according to the review comments:

1. Removes the cache directives
1. Tweaks how the user query is being done
1. Adds a `image_of` property to the response

* Bump API version

Co-authored-by: rhymes <rhymes@hey.com>
Co-authored-by: Molly Struve <mollylbs@gmail.com>
2020-10-14 14:24:25 -05:00
Jean-Francis Bastien
9ff7f82664
[deploy] API - New endpoint to retrieve the articles in the reading list of the authenticated user (#10540) 2020-10-14 13:20:03 -05:00
Lisa Sy
3377b5b69e
Update [authentication] in /admin/config (#10748)
* Write up new accordion view in markup

* Add inline SVG and edit padding of form

* Fix padding

* Remove extraneous buttons for current draft
2020-10-13 16:43:29 -04:00
Ben Halpern
8e9aeffd78
Add forem meta tags (#10747)
* Add forem meta tags

* Add docs

* Update docs/technical-overview/compatibility.md

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

* Update docs/technical-overview/compatibility.md

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

* Update docs/technical-overview/compatibility.md

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

* Update docs/technical-overview/compatibility.md

Co-authored-by: Jacob Herrington <jacobherringtondeveloper@gmail.com>
2020-10-09 14:13:14 -04:00
Rafal Trojanowski
2a488a19f8
Articles API: filtering by tags (#3654) (#10614)
* Articles API: filtering by tags (#3654)

* Address CR comments (#3654)

* Add test case
* Move tests
* Update docs

* Use _any_ option for querying by tags (#3654)
2020-10-09 12:49:34 +02:00
Christopher Wray
ab7d547bf1
Add Section for Series/Collections (#10719)
* Add Section for Series/Collections

I added a small section in this area of the docs to share some information about collections/ series. 

There is not much information in the documentation about collections or series and I felt like this would be beneficial to others looking to help with the Series feature of the website.

* Updated wording of collections section.
2020-10-09 12:37:31 +02:00
Andrew Bone
393f2d09af
Change admin password in docs (#10735)
Update default admin password in documentation
2020-10-08 09:28:05 -05:00
Ben Halpern
f87e9eace1
[deploy] Add feed_strategy config (#10245)
* Add feed_strategy config

* Add configs spec

* Fix specs

* Fix field test scenario

* Linting

* A couple small changes

* Rename Optimized and objects

* Add proper namespace

* Fix codeclimate

* Add docs

* Update docs/technical-overview/readme.md
2020-10-06 17:36:27 -04:00
Josh Puetz
c0272357c0
Add default admin to seeds file (#10620)
* Add default admin to seeds file

* Docs
2020-10-06 08:25:25 -05:00
Jacob Herrington
5ecc3f6880
Mention Facebook in authentication docs (#10622)
Setting up more auth options locally and noticed this
2020-10-06 08:22:15 +02:00
Rachael Wright-Munn
348aa3df15
[deploy] Add twitch liquid tags (#10577)
* Add a Liquid Tag specifically for Twitch clips.

These will embed Twitch Clips in articles and comments.

* Update documentation to incorporate Twitch clip liquid tags.

* Include Twitch Clips in video embed logic

* Making a small change to rebuild
2020-10-05 11:55:27 -04:00
Sabarish Rajamohan
e1b3844dfa
[deploy] Updated minimum requirements for local installation on Windows (#10513)
* Updated minimum requirements for local installation on Windows

* Added reference links to WSL 2 support in docs
2020-10-01 11:36:15 -04:00
rhymes
2d92c5d8e0
API: add docs for api/follows/tags (#10471) 2020-10-01 07:21:44 +02:00
Takuma
e6ee6e3662
Fix broken links to admin guide in document (#10295) 2020-09-16 17:22:15 -05:00
Rafi
8e46763a49
Adding note about branch naming (#10320) 2020-09-15 16:37:12 -05:00
Rafi
915c4ea476
Fixing links to tracking section in docs (#10326) 2020-09-15 16:35:50 -05:00
Kevin McGinn
3bce753303
[Documentation] Improvements to Windows installation & startup docs (#10243)
* fix elasticsearch tgz filename in windows docs

* add prereqs to running bin/startup in windows docs

* add tip for Sidekiq errors in app startup docs
2020-09-09 18:19:16 -04:00
Josh Puetz
7ab262b205
Add OAuth callback configuration to facebook docs (#10041)
* Add OAuth callback configuration to facebook docs

* Add screenshots
2020-09-04 09:56:17 -05:00
Alex
2a5a933ed1
Add routes for i18n (#10193)
* Add routes

* Update all_routes spec

* Add i18n route specs

* Add docs

* Docs cleanup

* Add note about fragment caching
2020-09-03 17:11:07 -04:00
ludwiczakpawel
11831e72c1
Extending documentation... (#10156)
* textarea component

* docs / faq: add new follower

* credits

* lang

* moving copy higher

* typo

* Update docs/faqs.md typo

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

* Update docs/faqs.md lang

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

* Update docs/faqs.md lang

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

* Update docs/faqs.md

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

* Update docs/faqs.md

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

* Update docs/faqs.md

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

* Update docs/faqs.md

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

* Update docs/faqs.md

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

* Update docs/faqs.md

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

* Update app/javascript/article-form/components/Title.jsx

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

* Update docs/faqs.md

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

* Update docs/faqs.md

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

* Update docs/faqs.md

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

* Update docs/faqs.md

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

Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-09-03 10:53:22 -04:00
Ben Halpern
dba151915b
[deploy] Allow initial user to sign up and configure app (#10073)
* Allow initial user to sign up and configure app

* Fix added value unneeded

* Make siteconfig public in tests

* Remove deprecated method and adjust seed default

* Add new controllers not to redirect for public

* Modify tests

* Edit test defaults

* Fix linting

* Add starter mode to seed file
2020-08-31 12:54:22 -04:00
Josh Puetz
b9010ec0b1
Add facebook page to Backend Guide index (#10027) [deploy] 2020-08-26 17:04:48 -05:00
Josh Puetz
d47d02f090
[deploy] Log in with Facebook (#9922)
* First draft of facebook auth

* Add Facebook welcome broadcast to seeds, data script

* Tests!

* Documentation

* Update docs with pictures

* User siteconfig/app config

* Adjust dropdown menu width to avoid wrap for Facebook button

* Add Facebook auth keys to SiteConfig properly

* Remove unnecessary VCR cassette

* Add omniauth facebook gem to vendor cache

* Use uid instead of email for nickname randomization

* Test fix, test for missing email in Facebook

* Update docs/backend/auth-facebook.md

Co-authored-by: Molly Struve <mollylbs@gmail.com>

* Typo fix!

* Don't default facebook auth settings to ApplicationConfig

Co-authored-by: Molly Struve <mollylbs@gmail.com>
2020-08-26 12:04:20 -04:00
Jacob Herrington
e7641b87d6
Fix a typo caused by markdown (#9995) 2020-08-25 15:41:59 -04:00
Takuma
92c62dcee0
Fix typo (#9958) 2020-08-24 15:54:34 -05:00
Ben Halpern
36ccfd55dd
[deploy] Add Twitter and GitHub keys to SiteConfig (#9899)
* Add Twitter and GitHub keys to SiteConfig

* Change docs

* Add notice about not taking affect right away
2020-08-20 15:58:15 -04:00
Mac Siri
5eda086e78
Use ApplicationController for liquid render (#9867) 2020-08-19 13:55:39 -04:00
Vaidehi Joshi
1531c182cc
Move .env_sample out of /config directory (#9868)
The `.env` file shouldn't live in the `/config` directory when it is created, but
currently, the `.env_sample` file lives within `/config`. This can be confusing and
cause ENV var issues if someone duplicates `.env_sample` and renames it to `.env`,
because none of their ENV variables will get picked up, since their `.env` file will
mistakenly end up in `/config`.

This change moves `.env_sample` out of `/config`, and updates the documentation/relevant
.yml files accordingly.
2020-08-19 18:18:30 +02:00