Skip to content

Commit 3662a69

Browse files
committed
Merge pull request #149 from filecoin-project/jen/toc
Update Readme to provide better navigation throughout all community platform for discussion and find resources
2 parents d04c696 + 6fcf92f commit 3662a69

File tree

1 file changed

+87
-54
lines changed

1 file changed

+87
-54
lines changed

README.md

Lines changed: 87 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,120 @@
11
# Community
22

3-
## Table of Contents
4-
53
- [Community](#community)
6-
- [Table of Contents](#table-of-contents)
7-
- [About](#about)
8-
- [Discuss](#discuss)
9-
- [Community forum](#community-forum)
10-
- [Chat](#chat)
11-
- [GitHub issues](#github-issues)
12-
- [Security issues and disclosures](#security-issues-and-disclosures)
13-
- [Ecosystem Projects](#ecosystem-projects)
14-
- [Showcase Your Project!](#showcase-your-project)
15-
- [Updates and Newsletter](#updates-and-newsletter)
16-
- [Events](#events)
17-
- [Community calls](#community-calls)
18-
- [Filecoin Meetups](#filecoin-meetups)
19-
- [Contributing](#contributing)
20-
- [Contributing Guidelines](#contributing-guidelines)
21-
- [Filecoin Shipyard](#filecoin-shipyard)
22-
- [Maintainers](#maintainers)
23-
- [License](#license)
4+
- [About](#about)
5+
- [Join the Community](#join-the-community)
6+
- [Forums](#forums)
7+
- [Filecoin Community Forum](#filecoin-community-forum)
8+
- [lotus Discussion Forum](#lotus-discussion-forum)
9+
- [Filecoin Proving Subsystem Discussion](#filecoin-proving-subsystem-discussion)
10+
- [Implementation Related Repo](#implementation-related-repo)
11+
- [Chat](#chat)
12+
- [GitHub issues](#github-issues)
13+
- [Security issues and disclosures](#security-issues-and-disclosures)
14+
- [Useful links](#useful-links)
15+
- [Ecosystem Projects](#ecosystem-projects)
16+
- [Showcase Your Project!](#showcase-your-project)
17+
- [Updates and Newsletter](#updates-and-newsletter)
18+
- [Filecoin Shipyard](#filecoin-shipyard)
19+
- [Events](#events)
20+
- [Community calls](#community-calls)
21+
- [Filecoin Meetups](#filecoin-meetups)
22+
- [Contributing](#contributing)
23+
- [Contributing Guidelines](#contributing-guidelines)
24+
- [Maintainers](#maintainers)
25+
- [License](#license)
2426

2527
## About
2628

27-
Welcome to the Filecoin community repository! You can treat this repo as your go-to for all meta, non-code discussions in the [*Discussions*](https://github.com/filecoin-project/community/discussions), documents used by multiple repositories (such as the Code of Conduct), and how to interact with the Filecoin project and other community members.
29+
Welcome to the Filecoin community repository! You can treat this repo as your go-to for all meta, non-code discussions in the [*Discussions Forum*](https://github.com/filecoin-project/community/discussions), documents used by multiple repositories (such as the Code of Conduct), and how to interact with the Filecoin project and other community members.
30+
31+
To get the latest network notifications, subscribe to [status.filecoin.io](https://status.filecoin.io).
32+
33+
If you are interested in discussing code or protocol design, feel free to come talk to us on our [forums](#forums), [chat channels](#chat), or in issues on our other [Filecoin project repos](https://github.com/filecoin-project).
34+
35+
## Join the Community
2836

29-
If you are interested in discussing code or protocol design, feel free to come talk to us on our [discussion forums](#community-forum), [chat channels](#chat), or in issues on our other [Filecoin project repos](https://github.com/filecoin-project).
37+
**> Note: Before posting to different communications channels, make sure to read the [Code of Conduct](https://github.com/filecoin-project/community/blob/master/CODE_OF_CONDUCT.md).**
3038

31-
## Discuss
39+
The vast majority of the Filecoin Project conversations, including implementation, community support, ecosystem news, etc. take place on:
3240

33-
The vast majority of the Filecoin Project conversations are held on:
41+
- [Forums](#forums) (mainly on Github Discussions)
42+
- GitHub Issues (see [Implementation related repo](#impelmentation-related-repo) section below)
43+
- Chat (mainly on Slack) (see [Chat](#chat) section below)
3444

35-
- GitHub Issues
36-
- Github Discussions
37-
- [The discussion forum](https://discuss.filecoin.io)
38-
- Chat (on Matrix/Slack/IRC) (see [Chat](#chat) section below)
45+
The Filecoin Project is an open sourced project with a very supportive and welcoming community, where many community members are responsive in various of forums and slack channels. We also have [Filecoin community ambassadors](https://github.com/filecoin-project/community/discussions/116#discussioncomment-617066) here to support you, tag their GitHub handlers in GitHub discussions or @fil-community-ambassadors in all slack channels if you have any questions!
3946

40-
We tend to be pretty responsive during normal business hours, which vary according to our timezones (we have a fully distributed team).
47+
Implementation dev teams tend to check their corresponding GitHub repo issues and discussions regularly and try to respond within 5 business days.
4148

4249
We also push updates to the community via:
4350

51+
- Forum - [`Network and implementations updates`](https://github.com/filecoin-project/community/discussions/categories/network-and-implementations-updates) updates and [`news and events`](https://github.com/filecoin-project/community/discussions/categories/news-and-events)
4452
- Filecoin blog: [https://blog.filecoin.io](https://blog.filecoin.io)
53+
- CryptoComputeLab blog(proof updates): [https://research.protocol.ai/groups/cryptocomputelab/](https://research.protocol.ai/groups/cryptocomputelab/)
54+
- Youtube: [Filecoin](https://www.youtube.com/channel/UCPyYmtJYQwxM-EUyRUTp5DA)
4555
- Twitter: [@Filecoin](https://twitter.com/Filecoin)
4656
- WeChat ID: Filecoin-Official
4757

4858
![filecoin qr code](/images/qrcode_for_gh_da36751a6108_1280.jpg)
4959

50-
Before posting to different communications channels, make sure to read the [Code of Conduct](https://github.com/filecoin-project/community/blob/master/CODE_OF_CONDUCT.md).
5160

52-
### Community forum
61+
### Forums
5362

54-
[https://github.com/filecoin-project/community/discussions](https://github.com/filecoin-project/community/discussions)
63+
#### Filecoin Community Forum
5564

56-
When in doubt, please post here!
65+
When in doubt or curiosity, please post in Filecoin community forum](https://github.com/filecoin-project/community/discussions) !
5766

5867
We love to hear what the community has to say, whether it is to:
5968

6069
- Ask a question
61-
- Propose a new feature
70+
- Gather community feedback on a new feature proposal before opening an FIP
6271
- Share a new project you're working on
6372
- Find collaborators for your own community project
6473
- And whatever else! Honestly!
6574

6675
The discussion forum uses the same Code of Conduct as our other community channels. Please make sure to read this before posting.
6776

77+
> Note: A Chinese-language community forum is also available at https://github.com/filecoin-project/community-china/discussions. It is managed by [CoinSummer](https://github.com/CoinSummer).
78+
79+
#### lotus Discussion Forum
80+
81+
[lotus discussion](https://github.com/filecoin-project/lotus/discussions) is an all-in-one place where you can track [lotus releases and announcements](https://github.com/filecoin-project/lotus/discussions/categories/announcement), find [tutorials](https://github.com/filecoin-project/lotus/discussions/categories/tutorials) ask questions about running[ a lotus node](https://github.com/filecoin-project/lotus/discussions/categories/syncing), [lotus miner ](https://github.com/filecoin-project/lotus/discussions/categories/miner-q-a)or lotus client, get help with troubleshooting, [share your lotus setup or thoughts](https://github.com/filecoin-project/lotus/discussions/categories/show-and-tell), chat with your fellow developers with [how to build ](https://github.com/filecoin-project/lotus/discussions/categories/developer-q-a)applications using lotus JsonRPC API and so on.
82+
83+
84+
#### Filecoin Proving Subsystem Discussion
85+
86+
The Filecoin Proving Subsystem (or FPS) provides the storage proofs required by the Filecoin protocol. If you have any question regard to the current proof, feedbacks for proof performance on different machines, ideas to improve proof or implementing new proof, join the [forum here](https://github.com/filecoin-project/rust-fil-proofs/discussions)!
87+
88+
### Implementation Related Repo
89+
6890
### Chat
6991

70-
You can join the conversation on chat via Matrix, IRC, and Slack.
92+
Vast majority of community live chat is happening in [Filecoin Project Slack](https://filecoin.io/slack). Tag @fil-community-ambassadors if you have any questions!
7193

72-
Our primary chat channels are bridged (automatically copied) across Matrix, IRC, and Slack:
94+
Fun channels to join once you are in the workspace:
7395

74-
- **Matrix:** The [Filecoin community](https://app.element.io/#/group/+filecoin:matrix.org) on Element (our preferred Matrix client)
75-
- **Filecoin Project Slack:** Create an account or login with your existing account at [https://filecoin.io/slack](https://filecoin.io/slack)
76-
- **IRC:** [Coming soon](https://github.com/filecoin-project/community/issues/4)
96+
- `#fil-announcements`: This channel is for official Filecoin announcements only (including network, implementations, and ecosystem announcements). Join to get most up-to-date news. Please do not post questions or other messages here; they will be deleted!
97+
- `_fil-lobby`: for general Filecoin-related sharing
98+
- `fil-help`: ask questions here if you can't find another specific channel for your question
99+
- `fil-lotus`: for lotus related discussion
100+
- `fil-fips`: for [Filecoin Improvement Proposals](https://github.com/filecoin-project/FIPs) related discussion
101+
- `fil-plus`: for Filecoin Plus([notary-governance](https://github.com/filecoin-project/notary-governance)) related discussion
102+
- `fil-net-calibration-discuss`/`fil-net-nerpa-discuss`: for testnet disucssions
103+
- `fil-ecosystem-dev`: for updates and discussion about building in the Filecoin ecosystem
104+
- `fil-deal-market`: promote your miner as a storage provider or find your provider as a client here
105+
- `hackathons-help`: join this channel if you are participating any Filecoin hackathons and have questions
106+
107+
Primary Slack channels are bridged (automatically mirrored and read-only) to [Matrix](https://app.element.io/#/group/+filecoin:matrix.org).
77108

78-
Note that you can generally think of the above options as interchangeable. Note, however, that some channels may not be bridged across chat spaces.
79109

80110
### GitHub issues
81111

82112
If you find something puzzling or encounter a straight-up bug in any of our repositories, please file a well-scoped issue. The issue lists for our most active repositories are below:
83113

84-
- [`lotus`](https://github.com/filecoin-project/lotus/issues)
114+
- [`lotus`](https://github.com/filecoin-project/lotus/issues) ([contribution guide](https://github.com/filecoin-project/lotus#contribute))
85115
- [`venus`](https://github.com/filecoin-project/venus/issues)
86116
- [`specs-actors`](https://github.com/filecoin-project/specs-actors/issues)
87-
- [`rust-proofs`](https://github.com/filecoin-project/rust-proofs/issues)
117+
- [`rust-ffi-proofs`](https://github.com/filecoin-project/rust-fil-proofs)
88118
- [`specs`](https://github.com/filecoin-project/specs/issues)
89119

90120
If a repo has a Contributing Guide, please read it before filing an issue!
@@ -95,9 +125,16 @@ Almost anything you find that is a bug in the codebase should be filed as an iss
95125

96126
Please refer to [SECURITY.md](./SECURITY.md) document found in this repo on how to best report findings and participate on the bug bounty program.
97127

128+
## Useful links
129+
130+
If you are new to the Filecoin Project, below are some helpful links for you to learn more about it:
131+
- Official website: [https://filecoin.io](https://filecoin.io)
132+
- [Filecoin Specification](https://spec.filecoin.io): contains documents, code, models, and diagrams that constitute the specification of the Filecoin Protocol.
133+
- [Filecoin Docs](https://docs.filecoin.io): offers all the necessary resources to learn about Filecoin, the software and the tools to contribute to the network, either as a user looking for storage, or as a miner providing it
134+
98135
## Ecosystem Projects
99136

100-
If your product uses Filecoin, you're in the Filecoin ecosystem! We'd love to see all awesome projects that are built on top of the Filecoin ecosystem to be known and get used by the Filecoin community!
137+
If your project uses Filecoin, you're in the Filecoin ecosystem! We'd love to see all awesome projects that are built on top of the Filecoin ecosystem to be known and get used by the Filecoin community!
101138

102139
### Showcase Your Project!
103140

@@ -112,6 +149,11 @@ Following the steps below to submit your projects to be featured in this this [r
112149

113150
We'd encourage all projects featured in this repo to share all of your thrilling updates with the community! Start a new comment with header `Project Name Update/Newsletter - Date` (i.e `## Slate Update - Feb, 2021`) in your project discussion to share the exciting news with the community!
114151

152+
### Filecoin Shipyard
153+
154+
[Filecoin Shipyard](https://github.com/filecoin-shipyard) is a home we created for projects built by the Filecoin community. We encourage you to take a look around to explore some early projects incubated by the Filecoin community! If you're building something new on top of Filecoin, feel free to request to to add your project to the Shipyard!
155+
156+
115157
## Events
116158

117159
Add our [Google Calendar](https://calendar.google.com/calendar/b/6?cid=ZmlsZWNvaW4ub3JnX2o3bW1ldjI0ZzgwcmVsbzU2cHFtMWVsMWUwQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20) or follow issues in this repo to keep track of events (meetups, hackathons, etc.) hosted by the Filecoin Project and/or Protocol Labs.
@@ -149,16 +191,12 @@ We use a common [Code of Conduct](https://github.com/filecoin-project/community/
149191

150192
Each repo should have its own contributing guide, called `CONTRIBUTING.md`. Here is an example [Contributing Guide for `venus`](https://github.com/filecoin-project/venus/blob/master/CONTRIBUTING.md).
151193

152-
### Filecoin Shipyard
153-
154-
[Filecoin Shipyard](https://github.com/filecoin-shipyard) is a home we created for projects built by the Filecoin community. We encourage you to take a look around to explore some early projects incubated by the Filecoin community! If you're building something new on top of Filecoin, feel free to request to to add your project to the Shipyard!
155-
156194
## Maintainers
157195

158-
Maintainers are responsible for maintaining the content of this repo, reviewing the issues and pull requests and moderate the [discussion](https://github.com/filecoin-project/community/discussions).
196+
Maintainers are responsible for maintaining the content of this repo, create an issue and tag one of the maintainers if you have any questions.
159197

160198
Current maintainers are:
161-
@jennijuju ([jennifer.wang@protocol.ai](jennifer.wang@protocol.ai))
199+
@jennijuju ([jennijuju@protocol.ai](jennijuju@protocol.ai))
162200

163201

164202
## License
@@ -167,8 +205,3 @@ The Filecoin Project is dual-licensed under Apache 2.0 and MIT terms:
167205

168206
- Apache License, Version 2.0, ([LICENSE-APACHE](https://github.com/filecoin-project/community/blob/master/LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
169207
- MIT license ([LICENSE-MIT](https://github.com/filecoin-project/community/blob/master/LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
170-
171-
172-
173-
174-

0 commit comments

Comments
 (0)