77 Commits

Author SHA1 Message Date
Olle Jonsson
7326cd8bfd
docs: Adapters, how to create them (#1193)
This begins a new section, probably we want to move the Parallel section to its own "Advanced Adapter authoring" or a subject-specific text. Anyway, we have started!
2020-10-22 11:55:46 +02:00
Joel Stimson
85b46bef6c
Remove retry_change_requests from documentation (#1185) 2020-10-06 10:33:29 +01:00
Matt
9af091f9c4
Improves documentation on how to contribute to the site by using Docker. (#1175) 2020-09-01 16:32:18 +01:00
Alexander Popov
680b9f8a6c Add EditorConfig file
Resolve issues.

More info here: https://editorconfig.org/
2020-04-19 22:56:50 +02:00
Olle Jonsson
3ca146de4d Update year markers to 2020 for a lively look 2020-04-03 18:18:51 +02:00
Marjan Povolni
e2c56e90c9 docs(website): fix request/response mix-up in text 2020-02-24 09:36:13 +01:00
Vincent Voyer
47dcf037a7
Merge branch 'master' into docs/add-documentation-search 2020-01-21 12:38:59 +01:00
Vincent Voyer
008321b24f docs(website): add search to the website
This commit adds documentation search to the whole website using Algolia's
DocSearch project: https://community.algolia.com/docsearch/.
Analytics are available via an Algolia account, ask vincent@codeagain.com for
more information.

I tried to be as close as the Faraday design as possible.
2020-01-21 12:38:12 +01:00
Olle Jonsson
6015ae97d6
[docs] Use "including" wording
By mentioning "including" instead of "configuring like this", we avoid the possible understanding "replace the whole list".
2020-01-09 10:37:22 +01:00
Vincent Voyer
024bfebd1a
docs(retry): precise usage of retry-after
fixes https://github.com/lostisland/faraday/pull/1109#issuecomment-572448991
2020-01-09 09:48:13 +01:00
Mattia
8a43a47919
Retry middleware documentation fix (#1109)
Fixes https://github.com/lostisland/faraday/pull/773#issuecomment-571089608
2020-01-08 20:20:44 +00:00
Amr El-Bakry
9726bc2029 Add log_level option to logger default formatter (#1079) 2019-12-27 17:02:08 +00:00
Julien Kirch
073bc25cd4 Very small fix in adapter documentation 2019-12-11 06:54:35 +01:00
rick olson
f7f91b7077 raise_error: update docs to mention nil status code 2019-10-15 13:37:41 -06:00
Stanisław Pitucha
cccc145e2f Describe clearing cached stubs
This was the solution proposed in https://github.com/lostisland/faraday/issues/1041
2019-10-07 19:48:59 +02:00
risk danger olson
80ba52c721
update multipart docs to mention ParamPart class (#1018)
* update multipart docs to mention ParamsPart class

* Use newer "FilePart" name

* annotate example

* Consistently use single quotes

* remove last UploadIO reference
2019-09-20 05:08:56 -06:00
risk danger olson
e8792e43d5 port changes from #1000 (#1004) 2019-07-19 14:11:30 +02:00
Lewis Cowles
ac27ce502e Configure Jekyll plugin jekyll-remote-theme to support Docker usage (#999)
I tried to build with Jekyll 3.6.x (`jekyll/jekyll:latest`). It went badly.

By following the author guide https://github.com/benbalter/jekyll-remote-theme I noticed we were missing a YAML configuration entry.
2019-07-09 22:05:10 +02:00
iMacTia
0ec66e8959 Fixes website navigation by adding trailing slashes to /index.md files.
See https://stackoverflow.com/questions/54727643/trailing-slashes-in-jekyll-github-pages-site-cause-404
2019-07-08 18:45:46 +01:00
rick olson
26c542d9e1 fix the order of the site nav 2019-07-02 07:43:06 -06:00
iMacTia
6cd8c5dc35 Fixes placeholders for Faraday website URL. 2019-06-27 15:47:06 +01:00
iMacTia
0826817f4e Switches back to standard theme. 2019-06-26 12:08:20 +01:00
iMacTia
5d3e667c1a Merge branch 'faraday-website' of https://github.com/lostisland/faraday into faraday-website 2019-06-26 09:54:16 +01:00
iMacTia
9070f6bf2e Fixes homepage title. 2019-06-26 09:53:44 +01:00
rick olson
62cbdb9d78 restructure adapters section:
* more prominent placing of test adapter
* remove next/prev navigation for adapter pages, they don't need to be read in order
* ensure all adapter pages link to top nav
2019-06-25 10:28:14 -06:00
rick olson
08cd1b3be9 top links to middleware pages 2019-06-25 10:09:12 -06:00
rick olson
caf7545906 add top links to usage pages 2019-06-25 10:07:43 -06:00
rick olson
75605b9c36 remove redundant sitemap 2019-06-25 09:59:18 -06:00
rick olson
2f96d9b3a7 rename Introduction section => to Usage 2019-06-25 09:38:52 -06:00
iMacTia
cf078cf20b Adds Elena contribution to team page and footer.
Aligns README footer with Website one.
2019-06-25 16:31:51 +01:00
iMacTia
637c81196b Use slim repo card in README. 2019-06-25 15:54:32 +01:00
iMacTia
5cf6753e60 Merge remote-tracking branch 'origin/faraday-website' into faraday-website 2019-06-18 17:57:40 +01:00
iMacTia
a50fcc413b Adds Team page with dynamic GitHub loading.
Styles website with new branding.
2019-06-18 17:57:27 +01:00
rick olson
32be8ce245 redundant title 2019-06-13 09:32:14 -06:00
rick olson
a8295c2c4a use conn local var 2019-06-13 09:31:36 -06:00
rick olson
5ca8630d9b use consistent url hints 2019-06-13 09:31:20 -06:00
rick olson
112331a325 use consistent "learn more" callouts with punctuation 2019-06-13 09:30:52 -06:00
iMacTia
32eacfd4ee Expands menu items. 2019-06-08 17:38:58 +01:00
iMacTia
a963c12a82 Fixes TODOs in introduction. 2019-06-08 17:32:19 +01:00
iMacTia
f851834ccd Merges Introduction and Basics pages.
Adds navigation to introduction section.
2019-06-08 17:29:03 +01:00
iMacTia
8434b225a1 Fixes link in homepage. 2019-06-08 17:23:46 +01:00
iMacTia
f1d72a4cdf Adds navigation to adapters section. 2019-06-08 17:19:00 +01:00
iMacTia
79da580283 Improves middleware documentation adding a diagram. 2019-06-08 17:05:44 +01:00
rick olson
681b6baa33 convert to regular markdown link 2019-06-05 15:24:37 -06:00
rick olson
31d03bec46 rewrite basics page. focus on making requests, not middleware. 2019-06-05 15:22:41 -06:00
iMacTia
78fd49eecf Use Font Awesome icons for docs nav. 2019-06-04 17:50:30 +01:00
iMacTia
069b422750 Reduces the amount of comments in code snippets. 2019-06-04 17:09:14 +01:00
iMacTia
9f99e11596 Fixes review comments. 2019-06-03 21:42:12 +01:00
iMacTia
caa877dc83 Fixes documentation nav menu to always use correct floating. 2019-06-02 15:13:44 +01:00
iMacTia
4400acfd2b Introduces documentation layout with bottom navigation links. 2019-06-02 15:09:35 +01:00