Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLORA-450] Add a guide for namespaces #451

Merged
merged 3 commits into from
Oct 8, 2023
Merged

[FLORA-450] Add a guide for namespaces #451

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42a4ac0
Add a guide for namespaces
tchoutri Oct 5, 2023
0a099d1
Fix link and wording
tchoutri Oct 7, 2023
d333ba6
Add changelog entry
tchoutri Oct 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
title: Flora.pm
slug: /
---

Read more about:

* [Namespaces](/namespaces)
43 changes: 43 additions & 0 deletions docs/docs/namespaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Flora Namespaces
slug: namespaces
---

In Flora, packages are categorised in a namespace to mark their provenance. They start with a `@` and allow us to refer to packages unambiguously or mark their importance.

## @haskell Packages

Some packages are foundational to the ecosystem and maintained by either the Core Libraries Committee or the GHC team, and this makes them unique in terms of the expectations we have from them.

These packages live in the [`@haskell`] namespace to show that they are stable and reliable. Some example of packages are `base`, `text`, `bytestring`, and `mtl`.

## @hackage Packages

This is where most third-party packages live, which you will find on [Hackage](https://hackage.haskell.org).

## @cardano Packages
RaoulHC marked this conversation as resolved.
Show resolved Hide resolved

Flora also indexes the [Cardano Haskell Packages (CHaP)][CHaP], whose packages live under the [`@cardano`] namespace.

To use them in your own project, insert the following configuration in your `cabal.project` file:

```
repository cardano
url: https://input-output-hk.github.io/cardano-haskell-packages
secure: True
root-keys:
3e0cce471cf09815f930210f7827266fd09045445d65923e6d0238a6cd15126f
443abb7fb497a134c343faf52f0b659bd7999bc06b7f63fa76dc99d631f9bea1
a86a1f6ce86c449c46666bda44268677abf29b5b2d2eb5ec7af903ec2f117a82
bcec67e8e99cabfa7764d75ad9b158d72bfacf70ca1d0ec8bc6b4406d1bf8413
c00aae8461a256275598500ea0e187588c35a5d5d7454fb57eac18d9edb86a56
d4a35cd3121aa00d18544bb0ac01c3e1691d618f462c46129271bccf39f7e8ee
```
and run `cabal update`.

[`@haskell`]: https://flora.pm/packages/@haskell
[`@cardano`]: https://flora.pm/packages/@haskell
tchoutri marked this conversation as resolved.
Show resolved Hide resolved
[`@hackage`]: https://flora.pm/packages/@hackage
[`@hackage/servant-server`]: https://flora.pm/packages/@hackage/servant-server
[`@haskell/text`]: https://flora.pm/packages/@haskell/text
[CHaP]: https://input-output-hk.github.io/cardano-haskell-packages