Commit graph

142 commits

Author SHA1 Message Date
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
Nadiya Karachevska
df857d860a Fix API inconsistencies between articles 'index' and 'show' (#4560)
* Fix API inconsistencies between articles 'index' and 'show'

* Update API docs; revert tags from articles index

* Fix specs

* Update specs
2019-10-24 11:56:55 -04:00
Ben Halpern
4ea7b03727
Add new font and theme config, plus new navbar config option (#4462)
* Initial changes for some new themes/fonts/etc.

* Add basic navbar config

* Finalize navbar config

* Make config_navbar non nullable

* Add dark_theme? to user decorator
2019-10-24 08:38:46 -04:00
Jenna Pederson
ee91310f3a Doc: Fix/clarify getting started docs (#4509) [ci skip] 2019-10-22 14:38:41 -04:00
Stefan
5e0ca550a7 Fix typo in liquid tags docs (#4533)
* fix typo

* fix typo
2019-10-22 10:07:54 -04:00
Abenet Tamiru
ff45dc5e6e Mention POSTGRES_VERSION variable in documentation (#4481) [ci skip] 2019-10-18 10:31:52 -04:00
Ryan Palo
6cbad11b8f [DOC] Update "Installing on Linux" docs with more error messages (#4468) [ci skip] 2019-10-17 11:24:13 -04:00
rhymes
baa279b963 [DOC] Add PostgreSQL to the stack list (#4473) [ci skip] 2019-10-17 10:56:00 -04:00
rhymes
89476fae08 Upgrade Ruby to 2.6.5 (#4451) 2019-10-17 09:34:31 -04:00
rhymes
83291b16c6 Update API docs to add error info and other small fixes (#4459) [ci skip] 2019-10-16 15:08:49 -04:00
Anna Anks Nowak
c4b5530e2e Add info about bumping API version to docs.dev (#4454)
* Add views count for authenticated users articles [#4250]

* Bump API version to 0.5.6 [#4250]

* Add info about bumping API docs version requirement

* Fix Create pull request link by linking to the docs
2019-10-16 09:04:36 -04:00
Anna Anks Nowak
ee8ae66e47 Add views count for authenticated users articles [#4250] (#4393)
* Add views count for authenticated users articles [#4250]

* Bump API version to 0.5.6 [#4250]
2019-10-15 21:39:17 -04:00
Enrico Grillo
c9c86a44ea [DOC] Update technical-overview.md (#4439) [ci skip] 2019-10-15 16:34:25 -04:00
Emilia Muresan
daff71321f Fix lints in app/javascript/src/components/ (#4261) [ci skip] 2019-10-15 16:11:18 -04:00
Jacob Herrington
691faf78ac Update the docs readme with instructions [ci skip] (#4361)
The readme should include instructions to run the docs site so that
people don't have to go searching for the contributing.md file if they
are stumbling upon the docs in their code editor instead of via the
docs.dev.to website.
2019-10-14 09:24:46 -04:00
Zev Averbach
999042b9b8 add two possible problems + solutions (#4371)
I ran into those today while trying to get everything set up locally. Hopefully this will help future contributors!
2019-10-14 08:43:30 -04:00
Nick Taylor
fbbda3ed82 Fix typo in debugging.md (#4374) [ci skip] 2019-10-11 12:22:13 -04:00
samuel-glitch
15d7e7629a Add a sentence to clarify GitHub Authentication (#4360) 2019-10-11 08:56:02 -04:00
Nick Taylor
cc7a3f692a VS Code Settings Update / Frontend Debug Documentation (#4346)
* Added Edge debug configuration for VS Code.

* Added frontend debug documentation.

* Some copy updates.

* Added the debugging docs to the TOC.
2019-10-10 13:10:03 -04:00
Joshua Tzucker
b61db22dc5 [DOC] Update PostgreSQL docs (#4345) [ci skip] 2019-10-10 10:28:17 -04:00
Ben Halpern
3db3f6fdc2
Fix gotchas with color preview and some style adjustments and add documentation (#4322) 2019-10-08 21:32:31 -04:00
Ben Halpern
c0faa20c90
Add more info to architecture (#4233)
* Add more info to architecture

* Fix various typos and improve clarity in docs
2019-10-08 11:29:44 -04:00
Jacob Herrington
8cebfd415d [DOC] Update DEV onboarding documentation (#4215) 2019-10-03 16:38:28 -04:00
Enrico Grillo
ccfae978b5 [DOC] Standardize punctuation, period (#4176) [ci skip] 2019-10-03 11:54:04 -04:00
Jacob Herrington
fa3612abf9 Fix technical overview doc layout [ci skip] (#4201) 2019-10-03 11:07:54 -04:00