Commit graph

166 commits

Author SHA1 Message Date
Michael Kohl
5c74464b30
Add documentation for ENVied & SiteConfig (#5841)
* Add documentation for ENVied & SiteConfig

* Add images

* Fix swapped screenshots and update list
2020-02-04 11:41:25 -06:00
Molly Struve
ccd9bc2553
add missing sha512 to ES mac docs (#5863) 2020-02-03 10:51:08 -05:00
Molly Struve
0409722899
Introduce Elasticsearch to DEV env (#5762) [deploy] 2020-02-03 09:12:05 -05:00
Vaidehi Joshi
d36faa6462
Add a note to clarify deploy preview link (#5800)
We never explicitly say that the deploy preview link only is applicable to docs changes, but we probably should!
2020-01-28 15:19:09 -08:00
Nick Taylor
c91080c371 Removed redundant yarn install command. (#5764) 2020-01-27 12:10:14 -06:00
Nick Taylor
d6cdedba9a More updates to frontend documentation (#5724)
* Updated styles documentation.

* Added some docs about dynamic import usage.

* Updated architecture overview doc.

* Changed some wording

* Changed some wording
2020-01-27 12:51:55 -05:00
rhymes
2665e9aa2b Update docs/frontend/styles.md (#5733)
There was a typo that precluded the markdown link to work
2020-01-26 14:33:28 -05:00
Vaidehi Joshi
8dd83298d1 Add documentation around our use of pg-bouncer [ci-skip] (#5710) 2020-01-24 16:02:05 -05:00
Nick Taylor
b980481d0d update frontend docs (#5706)
* Added InstantClick to frontend docs.

* Added linting/formatting section to frontend docs.

* Fixed up some wording about linting.

* Added documentation about styles to frontend docs.

* Fixed a typo.

* Cleaned up InstantClick docs.

* Fixed a typo
2020-01-24 15:22:27 -05:00
Alex
1ed8d4a8ce Fix typo in Algolia docs [ci skip] (#5659) 2020-01-23 12:21:32 -05:00
rhymes
7c94c8955a Update branching docs [ci skip] (#5666)
* Fix contributing guide TOC

* Sync branching docs with contributing guide

* Write about writing meaningful commit messages
2020-01-23 09:28:46 -05:00
Vaidehi Joshi
75dafe66da
Add note to help debug bin/setup issues. (#5651)
When starting the app for the first time, it's possible to run into some issues while trying to run `bin/setup`.
For example, when I started the app, I got an (unhelpful) error when running `bin/setup` and ended up figuring out the issue (needing to `yarn install`) by running the contents of the Procfile.dev file directly.

We should help point folks to this file so that they can run a command that gives them a more helpful error message, which should hopefully let them get the app up and running with any problems! :)
2020-01-22 14:37:08 -08:00
Shelley Vohr
b146528aa8 feat: add per-user Open Dyslexic font setting (#5037) [deploy]
* feat: add per-user Open Dyslexic font setting

* Adjust css slightly

Co-authored-by: Ben Halpern <bendhalpern@gmail.com>
2020-01-20 18:23:57 -05:00
Jacob Herrington
a1968f926d Add guide for Ransack to docs [ci skip] (#5554) 2020-01-17 14:02:05 -05:00
ludwiczakpawel
815a95e85d Adding info about disappearing tokens (#5523)
* adding info about disappearing tokens

* fixing copy + numbering issue
2020-01-17 08:46:55 -05:00
Ben Halpern
4e41e4a2ac
Add more info to architecture.md doc (#5541) 2020-01-16 16:33:51 -05:00
Alex
7d47c78e55 Fix typo in Skipping CI docs [ci skip] (#5538) 2020-01-15 18:53:01 -05:00
Molly Struve
ddb54d0422
Halt Deploys With release script if ENV variable DEPLOY_STATUS is set to blocked (#5510) [deploy] 2020-01-15 12:36:05 -05:00
ludwiczakpawel
06bf574e34 adding section for switching to free plan (#5514) 2020-01-15 08:38:58 -05:00
Michael Kohl
256448f1f3 Remove unused Envfile variables (#5474)
* Remove unused variables from Envfile

* Remove unused Twitter variables from Envfile

* Also remove GITHUB_TOKEN

* Change Twitter token screenshot URL
2020-01-14 12:05:35 -05:00
Molly Struve
9dc1f51a79
Update Heroku Release to Migrate and Load App (#5404) [deploy] 2020-01-08 13:43:00 -05:00
Nick Taylor
ce3c6b9974 Fixed a typo in a filename in docs. (#5343) 2020-01-03 08:29:02 -05:00
Robin
d7174923a2 Git scripts to sync or reset repository fork (#5055)
* Add script to clean / reset the fork and start from upstream

* Add script to sync fork with latest changes from upstream

* Remove swap file accidentially checked in

* Add exit on break to shell scripts and documentation of shell scripts to workflow-suggested workflow

Co-authored-by: Mac Siri <krairit.siri@gmail.com>
2019-12-30 13:58:16 -05:00
Molly Struve
2e661809b6 Introduce Sidekiq For Background Jobs (#5252)
* Introduce Sidekiq to the app and update RateLimitCheckerJob to use it

* fix rate limit checker spec with new sidekiq syntax

* add Sidekiq to tech stack overview

* Remove RateLimitChecker job change, add sidekiq web UI and testing support
2019-12-27 10:39:48 -05:00
Jacob Herrington
2dac64b39d Expand the testing docs (#5112)
* Add context to Acceptance Testing guide

* Add docs on Regression testing

* Expand CI skip docs

* Expand documentation on testing controllers [ci skip]
2019-12-16 15:16:16 -05:00
Ben Halpern
630c1b7425
Migrate to streaming app shell via serviceworkers (#5020) [deploy]
* Initial work for streaming app shell way of using serviceworkers

* Close in on serviceworker adjustment finalization

* Add docs and loading indicator

* Remove useless code

* Don't run on API

* Update app/javascript/contentDisplayPolicy/hideBlockedContent.js

* Fix small details

* Don't run serviceworker.js code in test env

* Fix JS in serviceworker

* Move private keyword to proper place in async controller

* Change shell_version to HEROKU_SLUG_COMMIT

* Update caching config

* Add test for async_info/shell_version
2019-12-16 12:21:33 -05:00
Lenmor Larroza Dimanalata
08b0886eb0 Fix Backend Guide > Roles admin links [ci skip] (#5118) 2019-12-16 09:25:48 -05:00
Ryan Smith
b809562a2f Fix Algolia signup link. (#5100) 2019-12-13 10:59:09 -06:00
Jacob Herrington
a63a11f930 Write docs on rolify admin workaround [ci skip] (#5078) 2019-12-13 08:23:55 -05:00
Ryan Smith
4dca3f9b24 Fix Technical Overview links [ci skip] (#5084) 2019-12-12 14:36:45 -05:00
Andrew Sverdrup
2af033fca9 Add Next Tech Liquid Tag (#4958) [deploy]
* Add liquid tag for Next Tech

* Add liquid tag for Next Tech

* Use project share URL in liquid tag.

* Update docs and specs with share token URL.
2019-12-10 15:19:30 -05:00
Molly Struve
90712f61c6
Remove memcache dalli gem and setup code (#5057) [deploy] 2019-12-09 11:37:53 -06:00
Molly Struve
834eb51e98
Replace Airbrake with Honeybadger (#5007) [deploy] 2019-12-05 11:29:51 -06:00
Mohamed ABDELLANI
0039e67467 Add redis container to docker-compose (#4965)
* Add redis container to docker-compose [fix issue 4962]

* Updates docker.md
2019-11-29 17:06:56 -05:00
Jacob Herrington
7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* Improve format and clarity of the docs [ci skip]

While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.

For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.

This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)

* Delegate markdown wrapping to Prettier

* Add linewrapping explanation in the docs [ci skip]
2019-11-26 08:40:53 -05:00
Takuma
18df55284e fix typo (#4896) 2019-11-25 08:16:35 -05:00
Jacob Herrington
5624b2e7f9 Add a link for Twitter developer access [ci skip] (#4891) 2019-11-25 08:16:16 -05:00
Jacob Herrington
c6c5421163 Javascript automated testing and a11y doc (#4873)
* Add jext-axe package and introduce a11y testing

Automated a11y testing is NOT comprehensive. We cannot expect this to
even scratch the surface of potential a11y issues.

However, we can expect to find a percentage of issues that are currently
flying under the radar. Adopting some automation around a11y testing
also allows us to use CI to find a11y regressions -- which should be
really handy.

I've never really used Jest before, and Preact seems to make it a little
more complicated, but as far as I can tell, this is a decent way to add
at least some minor automated a11y testing.

* Add doc about automated a11y tests
2019-11-22 08:32:01 -05:00
rhymes
c8903876c6 Upgrade docs Ruby version to 2.6.5, same as the main app (#4872) 2019-11-21 08:16:13 -05:00
Ben Halpern
015b4bbc87
Update docs with more architecture info (#4813) 2019-11-14 08:58:47 -05:00
rhymes
1924a77a10 [DOC] Move architecture to technical overview (#4746) 2019-11-07 14:28:23 -05:00
Nadiya Karachevska
24a02fd695 Change SimpleCov to be on by default (#4666) [ci skip] 2019-10-31 11:18:32 -04:00
Molly Struve
69e35dc1b3 Add Redis gem and Create RedisClient (#4582)
* Add redis gem and client

* use keyword arguments in redis initializer

* check for REDISCLOUD_URL and fallback on REDIS_URL when connecting to redis

* dont parse Redis url in initializer
2019-10-30 10:32:59 -04:00
Nick Taylor
22991239bf Ran all markdown files through prettier to fix a handful. (#4599) 2019-10-28 08:20:53 -04:00
Ron Tal
e226a8e70d removed irrelevant word from docs (#4601) 2019-10-26 12:15:13 -04:00
Mac Siri
b70186af0b Add Condition for deployment (#4578)
* Add conditional deployment

* Update deployment doc
2019-10-25 12:25:44 -04:00
rhymes
d0bc58b133 API docs updates (#4585)
* Add operationId to all operations

* Add top level tags array

* Add users tag and cleanup /me descriptions

* Add beta to the title

* Update Article Index and Show examples after #4560

* Bump version

* Remove rendundant type object from refs
2019-10-25 10:30:33 -04:00
rhymes
8989a52aba Strip EXIF and GPS data from uploaded images (#4450)
* Add specs for ArticleImageUploader

* Add specs for BadgeUploader

* Add specs for CoverImageUploader

* Add specs for ProfileImageUploader

* Refactor uploaders to inherit from BaseUploader

* Strip EXIF and GPS data from uploaded images

* Add ImageMagick to the docs

* Protect strip_exif
2019-10-24 16:35:10 -04:00
Enrico Grillo
7423d05af6 Doc: Add mailto link in licensing.md (#4440) [ci skip] 2019-10-24 15:45:28 -04:00
Mac Siri
ba82deca90
Create doc on deployment CI/CD process (#4563) [ci skip] 2019-10-24 15:24:02 -04:00