-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
49 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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..." |