Commit graph

22 commits

Author SHA1 Message Date
Vaidehi Joshi
e49999ded0
Link to tracking docs from gitdocs sidebar (#8918) [deploy] 2020-06-25 13:14:08 -07:00
Vaidehi Joshi
dd6794a43b
Add documentation for tracking (#8914) [deploy]
* Add documentation for tracking

* Reword a sentence in backend tracking documentation
2020-06-25 11:47:51 -07:00
Francisco Quintero
3b939f6b9f
[deploy] Add Reddit Liquid Tag (#8111)
* Implement Reddit liquid tag

* Set reddit content in locals

* Change Reddit liquid tag content layout

I decided a UI similar to the Stack Exchange tag would be better.

Now the Reddit tag looks a bit similar.

* Add tests for RedditTag

* Add reddit liquid tag example to docs

Also emphasize notice about compilation of article when using any
liquid tag

* Parse markdown text reddit content for RedditTag

* Display date RedditTag post was published

* Remove file location comments

* Change order of conditional for Reddit liquid tag

Sometimes the attribute `post_hint` might be null and neither condition
would apply.

* Add example to use Reddit liquid tag

* Change reddit svg icon for Reddit liquid tag

* handle and verify status of Reddit links

Here we make sure the passed link is a valid one in terms of URI composition (e.g. protocol)
but also that the URL is one that points to existing content in Reddit.

If the URL isn't returning anything but a successful response code (200) then
we treat it as an invalid one.

* Do not use VCR for RedditTag specs

The generated cassette for this tag was really huge (6000+ lines).

Using mocks (as in the MediumTag spec) still does the job and without
that huge VCR file.

* Remove index line from schema.db

* Improve RedditJsonFromUrlService

- Change User-Agent in requests to one read from app configuration
- Remove Reddit URL check by making a GET request
- Add regexp to validate URL looks like a Reddit URL

* Move RedditJsonFromUrlService methods to RedditTag

Also changed the way the request was being mocked. Previously, it was by
mocking the service class now I'm mocking HTTParty directly and returning
the JSON structure Reddit uses.
2020-06-01 18:52:07 -04:00
Molly Struve
4c779be2ed
[deploy] Remove ALL Algolia Code (#7577) 2020-04-29 10:11:57 -05:00
Maja Komel
4499e5eb6e
[deploy] Add Wikipedia liquid tag (#7193) 2020-04-22 17:54:56 +02:00
Nick Taylor
ccf7e6e5bf
Upgrade to webpacker/webpack 4 and Babel 7 (#6664)
Upgraded to webpacker 4/webpack 4 and Babel 7
2020-03-17 08:20:36 -04:00
Nick Taylor
1f3d88c9b3
Created documenation for Common PropTypes. (#5900) 2020-02-05 17:22:16 -05:00
Nick Taylor
5ede660601
Preact/React developer tools documentation. (#5884) 2020-02-05 17:21:09 -05: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
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
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
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
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
Stefan
5e0ca550a7 Fix typo in liquid tags docs (#4533)
* fix typo

* fix typo
2019-10-22 10:07:54 -04:00
Nick Taylor
fbbda3ed82 Fix typo in debugging.md (#4374) [ci skip] 2019-10-11 12:22:13 -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
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
4ea1e6e020 Fix typos and mechanical mistakes (#4177) [ci skip] 2019-10-01 16:30:13 -04:00
Jean-Michel Fayard
4af02c8a48 Support for runnable kotlin snippets #3776 (#3801) 2019-08-29 16:06:17 -04:00
rhymes
9210f6793b Improvements on dev docs (#2616)
* Correct installation documentation

* Add stylized titles

* Add some changes to the getting started documentation

* Add changes for the backend guide

* Add changes for the design guide

* Add testing / Q&A guide improvements

* Minor fixes to contributing docs

* More improvements to the general doc

* Improvements for frontend guide
2019-04-29 18:54:29 -04:00
Andrew Brown
30dcb23169 #2507 - refactor GitDocs documentation (#2595)
* #2507 - refactor GitDocs documentation

* #2507 - fix grammar and spelling errors
2019-04-29 10:08:22 -04:00