eeva/servant
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

point to www.servant.dev (website) and docs.servant.dev (self-explanatory)

Browse source
This commit is contained in:
Alp Mestanogullari 2019-03-02 10:08:03 +01:00
parent 960aee0dbe
commit a386dd2095
37 changed files with 59 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -4,14 +4,14 @@
## Getting Started
We have a [tutorial](http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html) that
We have a [tutorial](http://docs.servant.dev/en/stable/tutorial/index.html) that
introduces the core features of servant. After this article, you should be able
to write your first servant webservices, learning the rest from the haddocks'
examples.
The central documentation can be found [here](http://haskell-servant.readthedocs.org/).
The central documentation can be found [here](http://docs.servant.dev/).
Other blog posts, videos and slides can be found on the
[website](http://haskell-servant.github.io/).
[website](http://www.servant.dev/).
If you need help, drop by the IRC channel (#servant on freenode) or [mailing
list](https://groups.google.com/forum/#!forum/haskell-servant).

2
doc/cookbook/basic-auth/basic-auth.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-basic-auth
version: 0.1
synopsis: Basic Authentication cookbook example
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/basic-streaming/basic-streaming.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-basic-streaming
version: 2.1
synopsis: Streaming in servant without streaming libs
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/curl-mock/curl-mock.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-curl-mock
version: 0.1
synopsis: Generate curl mock requests cookbook example
homepage: http://haskell-servant.readthedocs.org
homepage: http://docs.servant.dev
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/db-postgres-pool/db-postgres-pool.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-db-postgres-pool
version: 0.1
synopsis: Simple PostgreSQL connection pool cookbook example
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/db-sqlite-simple/db-sqlite-simple.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-db-sqlite-simple
version: 0.1
synopsis: Simple SQLite DB cookbook example
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/file-upload/FileUpload.lhs
View file

@ -126,7 +126,7 @@ Content of "README.md"
## Getting Started
We have a [tutorial](http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html) that
We have a [tutorial](http://docs.servant.dev/en/stable/tutorial/index.html) that
introduces the core features of servant. After this article, you should be able
to write your first servant webservices, learning the rest from the haddocks'
examples.

2
doc/cookbook/file-upload/file-upload.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-file-upload
version: 0.1
synopsis: File upload cookbook example
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/generic/generic.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-generic
version: 0.1
synopsis: Using custom monad to pass a state between handlers
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/hoist-server-with-context/hoist-server-with-context.cabal
View file

@ -3,7 +3,7 @@ version: 0.0.1
synopsis: JWT and basic access authentication with a Custom Monad cookbook example
description: Using servant-auth to support both JWT-based and basic
authentication.
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/https/https.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-https
version: 0.1
synopsis: HTTPS cookbook example
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/jwt-and-basic-auth/jwt-and-basic-auth.cabal
View file

@ -3,7 +3,7 @@ version: 0.0.1
synopsis: JWT and basic access authentication cookbook example
description: Using servant-auth to support both JWT-based and basic
authentication.
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/pagination/pagination.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-pagination
version: 2.1
synopsis: Pagination with Servant example
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/sentry/sentry.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-sentry
version: 0.1
synopsis: Collecting runtime exceptions using Sentry
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/structuring-apis/structuring-apis.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-structuring-apis
version: 0.1
synopsis: Example that shows how APIs can be structured
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/testing/testing.cabal
View file

@ -2,7 +2,7 @@ name: cookbook-testing
version: 0.0.1
synopsis: Common testing patterns in Servant apps
description: This recipe includes various strategies for writing tests for Servant.
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/using-custom-monad/using-custom-monad.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-using-custom-monad
version: 0.1
synopsis: Using custom monad to pass a state between handlers
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/cookbook/using-free-client/using-free-client.cabal
View file

@ -1,7 +1,7 @@
name: cookbook-using-free-client
version: 0.1
synopsis: Using Free client
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
license: BSD3
license-file: ../../../servant/LICENSE
author: Servant Contributors

2
doc/examples.md
View file

@ -8,7 +8,7 @@
- **[servant-examples](https://github.com/sras/servant-examples)**:
Similar to [the cookbook](https://haskell-servant.readthedocs.io/en/latest/cookbook/index.html) but
Similar to [the cookbook](https://docs.servant.dev/en/latest/cookbook/index.html) but
with no explanations, for developers who just want to look at code examples to find out how to do X or Y
with servant.

4
doc/links.rst
View file

@ -3,7 +3,7 @@ Helpful Links
-------------
- the central documentation (this site):
`haskell-servant.readthedocs.org <http://haskell-servant.readthedocs.org/>`_
`docs.servant.dev <http://docs.servant.dev/>`_
- the github repo:
`github.com/haskell-servant/servant <https://github.com/haskell-servant/servant>`_
@ -18,7 +18,7 @@ Helpful Links
`groups.google.com/forum/#!forum/haskell-servant <https://groups.google.com/forum/#!forum/haskell-servant>`_
- blog posts and videos and slides of some talks on servant:
`haskell-servant.github.io <http://haskell-servant.github.io>`_
`www.servant.dev <http://www.servant.dev>`_
- the servant packages on hackage:

4
doc/tutorial/tutorial.cabal
View file

@ -3,8 +3,8 @@ version: 0.10
synopsis: The servant tutorial
description:
The servant tutorial can be found at
<http://haskell-servant.readthedocs.org/>
homepage: http://haskell-servant.readthedocs.org/
<http://docs.servant.dev/>
homepage: http://docs.servant.dev/
category: Servant, Documentation
license: BSD3
license-file: LICENSE

2
servant-client-core/CHANGELOG.md
View file

@ -168,7 +168,7 @@
Just like `hoistServer` allows us to change the monad in which request handlers
of a web application live in, we also have `hoistClient` for changing the monad
in which *client functions* live.
Read [tutorial section for more information](https://haskell-servant.readthedocs.io/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
Read [tutorial section for more information](https://docs.servant.dev/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
([#936](https://github.com/haskell-servant/servant/pull/936))
iF you have own combinators, you'll need to define a new method of

2
servant-client-core/servant-client-core.cabal
View file

@ -8,7 +8,7 @@ description:
This library provides backend-agnostic generation of client functions. For
more information, see the README.
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

4
servant-client-ghcjs/README.md
View file

@ -4,12 +4,12 @@ Type safe querying of servant APIs from the browser.
`servant-client-ghcjs` is much like `servant-client`, as both packages allow you to generate functions that query the endpoints of your servant API. Both packages should feel the same in usage. The big difference lies in how they perform the actual requests. `servant-client` (indirectly) uses your operating system's socket mechanisms, whereas `servant-client-ghcjs` uses your browser's [XHR](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/Using_XMLHttpRequest) mechanisms to send requests.
This guide assumes knowledge of servant. Reading its [documentation](http://haskell-servant.readthedocs.io) is recommended if you're new to the subject.
This guide assumes knowledge of servant. Reading its [documentation](http://docs.servant.dev) is recommended if you're new to the subject.
## Using servant-client-ghcjs
`servant-client-ghcjs` should feel familiar if you've worked with `servant-client`.
Take the following API (taken from the [Querying an API](http://haskell-servant.readthedocs.io/en/stable/tutorial/Client.html) section in the servant documentation)
Take the following API (taken from the [Querying an API](http://docs.servant.dev/en/stable/tutorial/Client.html) section in the servant documentation)
```haskell
{-# LANGUAGE DataKinds #-}

4
servant-client-ghcjs/servant-client-ghcjs.cabal
View file

@ -9,11 +9,11 @@ description:
This library lets you automatically derive Haskell functions that
let you query each endpoint of a <http://hackage.haskell.org/package/servant servant> webservice.
.
See <http://haskell-servant.readthedocs.org/en/stable/tutorial/Client.html the client section of the tutorial>.
See <http://docs.servant.dev/en/stable/tutorial/Client.html the client section of the tutorial>.
.
<https://github.com/haskell-servant/servant/blob/master/servant-client/CHANGELOG.md CHANGELOG>
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

2
servant-client/CHANGELOG.md
View file

@ -147,7 +147,7 @@
Just like `hoistServer` allows us to change the monad in which request handlers
of a web application live in, we also have `hoistClient` for changing the monad
in which *client functions* live.
Read [tutorial section for more information](https://haskell-servant.readthedocs.io/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
Read [tutorial section for more information](https://docs.servant.dev/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
([#936](https://github.com/haskell-servant/servant/pull/936))
- *servant-client* Add more constructors to `RequestBody`, including

4
servant-client/servant-client.cabal
View file

@ -8,11 +8,11 @@ description:
This library lets you derive automatically Haskell functions that
let you query each endpoint of a <http://hackage.haskell.org/package/servant servant> webservice.
.
See <http://haskell-servant.readthedocs.org/en/stable/tutorial/Client.html the client section of the tutorial>.
See <http://docs.servant.dev/en/stable/tutorial/Client.html the client section of the tutorial>.
.
<https://github.com/haskell-servant/servant/blob/master/servant-client/CHANGELOG.md CHANGELOG>
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

2
servant-conduit/servant-conduit.cabal
View file

@ -9,7 +9,7 @@ description: Servant Stream support for conduit.
.
Provides 'ToSourceIO' and 'FromSourceIO' instances for 'ConduitT'.
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

2
servant-docs/servant-docs.cabal
View file

@ -12,7 +12,7 @@ description:
.
<https://github.com/haskell-servant/servant/blob/master/servant-docs/CHANGELOG.md CHANGELOG>
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

2
servant-foreign/servant-foreign.cabal
View file

@ -14,7 +14,7 @@ description:
.
<https://github.com/haskell-servant/servant/blob/master/servant-foreign/CHANGELOG.md CHANGELOG>
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

4
servant-http-streams/servant-http-streams.cabal
View file

@ -8,11 +8,11 @@ description:
This library lets you derive automatically Haskell functions that
let you query each endpoint of a <http://hackage.haskell.org/package/servant servant> webservice.
.
See <http://haskell-servant.readthedocs.org/en/stable/tutorial/Client.html the client section of the tutorial>.
See <http://docs.servant.dev/en/stable/tutorial/Client.html the client section of the tutorial>.
.
<https://github.com/haskell-servant/servant/blob/master/servant-client/CHANGELOG.md CHANGELOG>
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

2
servant-machines/servant-machines.cabal
View file

@ -9,7 +9,7 @@ description: Servant Stream support for machines.
.
Provides 'ToSourceIO' and 'FromSourceIO' instances for 'MachineT'.
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

2
servant-pipes/servant-pipes.cabal
View file

@ -9,7 +9,7 @@ description: Servant Stream support for pipes.
.
Provides 'ToSourceIO' and 'FromSourceIO' instances for 'Proxy' and 'SafeT'.
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

2
servant-server/README.md
View file

@ -6,4 +6,4 @@ This library lets you *implement* an HTTP server with handlers for each endpoint
## Getting started
We've written a [tutorial](http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html) guide that introduces the core types and features of servant. After this article, you should be able to write your first servant webservices, learning the rest from the haddocks' examples.
We've written a [tutorial](http://docs.servant.dev/en/stable/tutorial/index.html) guide that introduces the core types and features of servant. After this article, you should be able to write your first servant webservices, learning the rest from the haddocks' examples.

4
servant-server/servant-server.cabal
View file

@ -7,7 +7,7 @@ category: Servant, Web
description:
A family of combinators for defining webservices APIs and serving them
.
You can learn about the basics in the <http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html tutorial>.
You can learn about the basics in the <http://docs.servant.dev/en/stable/tutorial/index.html tutorial>.
.
<https://github.com/haskell-servant/servant/blob/master/servant-server/example/greet.hs Here>
is a runnable example, with comments, that defines a dummy API and implements
@ -15,7 +15,7 @@ description:
.
<https://github.com/haskell-servant/servant/blob/master/servant-server/CHANGELOG.md CHANGELOG>
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE

26
servant/CHANGELOG.md
View file

@ -203,18 +203,18 @@
[#985](https://github.com/haskell-servant/servant/pull/985)
- *Documentation* Tutorial and new recipes
- [Using free client](https://haskell-servant.readthedocs.io/en/latest/cookbook/using-free-client/UsingFreeClient.html)
- [Using free client](https://docs.servant.dev/en/latest/cookbook/using-free-client/UsingFreeClient.html)
[#1005](https://github.com/haskell-servant/servant/pull/1005)
- [Generating mock curl calls](https://haskell-servant.readthedocs.io/en/latest/cookbook/curl-mock/CurlMock.html)
- [Generating mock curl calls](https://docs.servant.dev/en/latest/cookbook/curl-mock/CurlMock.html)
[#1033](https://github.com/haskell-servant/servant/pull/1033)
- [Error logging with Sentry](https://haskell-servant.readthedocs.io/en/latest/cookbook/sentry/Sentry.html)
- [Error logging with Sentry](https://docs.servant.dev/en/latest/cookbook/sentry/Sentry.html)
[#987](https://github.com/haskell-servant/servant/pull/987)
- [Hoist Server With Context for Custom Monads](https://haskell-servant.readthedocs.io/en/latest/cookbook/hoist-server-with-context/HoistServerWithContext.html)
- [Hoist Server With Context for Custom Monads](https://docs.servant.dev/en/latest/cookbook/hoist-server-with-context/HoistServerWithContext.html)
[#1044](https://github.com/haskell-servant/servant/pull/1044)
- [How To Test Servant Applications](https://haskell-servant.readthedocs.io/en/latest/cookbook/testing/Testing.html)
- [How To Test Servant Applications](https://docs.servant.dev/en/latest/cookbook/testing/Testing.html)
[#1050](https://github.com/haskell-servant/servant/pull/1050)
- `genericServeT`: using custom monad with `Servant.API.Generic`
in [Using generics](https://haskell-servant.readthedocs.io/en/latest/cookbook/generic/Generic.html)
in [Using generics](https://docs.servant.dev/en/latest/cookbook/generic/Generic.html)
[#1058](https://github.com/haskell-servant/servant/pull/1058)
- Tutorial
[#974](https://github.com/haskell-servant/servant/pull/974)
@ -282,7 +282,7 @@
Just like `hoistServer` allows us to change the monad in which request handlers
of a web application live in, we also have `hoistClient` for changing the monad
in which *client functions* live.
Read [tutorial section for more information](https://haskell-servant.readthedocs.io/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
Read [tutorial section for more information](https://docs.servant.dev/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
([#936](https://github.com/haskell-servant/servant/pull/936))
iF you have own combinators, you'll need to define a new method of
@ -329,10 +329,10 @@
- Added tests or enabled tests
([#975](https://github.com/haskell-servant/servant/pull/975))
- Add [pagination cookbook recipe](https://haskell-servant.readthedocs.io/en/release-0.14/cookbook/pagination/Pagination.html)
- Add [pagination cookbook recipe](https://docs.servant.dev/en/release-0.14/cookbook/pagination/Pagination.html)
([#946](https://github.com/haskell-servant/servant/pull/946))
- Add [`servant-flatten` "spice" to the structuring api recipe](https://haskell-servant.readthedocs.io/en/release-0.14/cookbook/structuring-apis/StructuringApis.html)
- Add [`servant-flatten` "spice" to the structuring api recipe](https://docs.servant.dev/en/release-0.14/cookbook/structuring-apis/StructuringApis.html)
([#929](https://github.com/haskell-servant/servant/pull/929))
- Dependency updates
@ -382,9 +382,9 @@
```
See tutorial for more details
- [A web API as a type - StreamGet and StreamPost](http://haskell-servant.readthedocs.io/en/release-0.13/tutorial/ApiType.html#streamget-and-streampost)
- [Serving an API - streaming endpoints](http://haskell-servant.readthedocs.io/en/release-0.13/tutorial/Server.html#streaming-endpoints)
- [Querying an API - Querying Streaming APIs](http://haskell-servant.readthedocs.io/en/release-0.13/tutorial/Client.html#querying-streaming-apis)
- [A web API as a type - StreamGet and StreamPost](http://docs.servant.dev/en/release-0.13/tutorial/ApiType.html#streamget-and-streampost)
- [Serving an API - streaming endpoints](http://docs.servant.dev/en/release-0.13/tutorial/Server.html#streaming-endpoints)
- [Querying an API - Querying Streaming APIs](http://docs.servant.dev/en/release-0.13/tutorial/Client.html#querying-streaming-apis)
- *servant* Add `Servant.API.Modifiers`
([#873](https://github.com/haskell-servant/servant/pull/873)
@ -415,7 +415,7 @@
([#893](https://github.com/haskell-servant/servant/pull/893))
- *Cookbook* example projects at
http://haskell-servant.readthedocs.io/en/master/cookbook/index.html
http://docs.servant.dev/en/master/cookbook/index.html
([#867](https://github.com/haskell-servant/servant/pull/867)
[#892](https://github.com/haskell-servant/servant/pull/882))

4
servant/servant.cabal
View file

@ -7,11 +7,11 @@ category: Servant, Web
description:
A family of combinators for defining webservices APIs and serving them
.
You can learn about the basics in the <http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html tutorial>.
You can learn about the basics in the <http://docs.servant.dev/en/stable/tutorial/index.html tutorial>.
.
<https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md CHANGELOG>
homepage: http://haskell-servant.readthedocs.org/
homepage: http://docs.servant.dev/
bug-reports: http://github.com/haskell-servant/servant/issues
license: BSD3
license-file: LICENSE