Skip to content

Commit

Permalink
Normalize tansu.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
tupui committed Aug 10, 2024
1 parent 7f3300f commit bc04b82
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 2 deletions.
4 changes: 2 additions & 2 deletions website/docs/developers/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ sidebar_position: 2

![General diagram flow](./architecture.png)

:::note
:::note[Maintainer]

Maintainer: a person which is part of a project’s team. This is not necessarily tight to any specific role nor commit rights.
A person which is part of a project’s team. This is not necessarily tight to any specific role nor commit rights.

:::

Expand Down
24 changes: 24 additions & 0 deletions website/docs/developers/project_information_file.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_position: 2
---

import CodeBlock from "@theme/CodeBlock";
import tansu_toml from "!!raw-loader!./tansu.toml";

# Tansu information file

Metadata on the projects are defined in a TOML file using the [SEP-1](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md) specification-which standardize the Stellar Info File. This file is to be named `tansu.toml` as to avoid the confusion and collision with `stellar.toml`.

- `DOCUMENTATION`: information about the project
- `ACCOUNTS`: public keys of the maintainers
- `PRINCIPALS`: information about maintainers. At least the GitHub handle should be present.

:::note[Order matters]

The order of both `ACCOUNTS` and `PRINCIPALS` is important as to link a maintainer with its public key.

:::

Bellow is a complete example of a project information file:

<CodeBlock language="toml">{tansu_toml}</CodeBlock>
23 changes: 23 additions & 0 deletions website/docs/developers/tansu.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
VERSION="2.0.0"

ACCOUNTS=[
"GA...",
"GB...",
"GC..."
]

[DOCUMENTATION]
ORG_NAME="Organization Name"
ORG_URL="https://www.domain.com"
ORG_LOGO="https://www.domain.com/awesomelogo.png"
ORG_DESCRIPTION="Description of project"
ORG_GITHUB="orgcode"

[[PRINCIPALS]]
github="Handle maintainer GA..."

[[PRINCIPALS]]
github="Handle maintainer GB..."

[[PRINCIPALS]]
github="Handle maintainer GC..."

0 comments on commit bc04b82

Please sign in to comment.