Skip to content

Commit 7a710b9

Browse files
authored
community section layout and README update, add info about support (ipfs#1473)
1 parent f17c4e5 commit 7a710b9

File tree

6 files changed

+118
-55
lines changed

6 files changed

+118
-55
lines changed

docs/.vuepress/config.js

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -259,28 +259,8 @@ module.exports = {
259259

260260
],
261261
'/community/': [
262-
{
263-
title: 'Join the community',
264-
sidebarDepth: 2,
265-
collapsable: true,
266-
children: [
267-
[
268-
'https://ipfs.us4.list-manage.com/subscribe?u=25473244c7d18b897f5a1ff6b&id=cad54b2230',
269-
'IPFS newsletter'
270-
],
271-
'/community/contribute/ways-to-contribute',
272-
['https://discuss.ipfs.tech/', 'IPFS forums'],
273-
'/community/chat',
274-
['https://proto.school/events', 'ProtoSchool workshops'],
275-
['https://www.meetup.com/members/249142444/', 'Meetups'],
276-
'/community/social-media',
277-
['https://awesome.ipfs.tech', 'Awesome IPFS'],
278-
[
279-
'https://www.youtube.com/channel/UCdjsUXJ3QawK4O5L1kqqsew',
280-
'YouTube'
281-
]
282-
]
283-
},
262+
['/community/', 'Join the community'],
263+
'/community/contribute/ways-to-contribute',
284264
{
285265
title: 'Write the docs',
286266
sidebarDepth: 1,
@@ -296,17 +276,16 @@ module.exports = {
296276
'/project/repository-guide',
297277
'/project/related-projects',
298278
'/project/implementation-status',
299-
['https://github.com/ipfs/roadmap', 'Roadmap'],
300279
['https://github.com/ipfs/specs', 'Specifications'],
301-
['https://github.com/ipfs/research', 'Research'],
302-
['https://github.com/ipfs/team-mgmt', 'Team org planning'],
280+
['/concepts/further-reading/academic-papers', 'Research'],
303281
[
304282
'https://github.com/ipfs/community/blob/master/code-of-conduct.md',
305283
'Code of conduct'
306284
],
307285
],
308286
'/project/' : [
309287
['/community/', 'Join the community'],
288+
'/community/contribute/ways-to-contribute',
310289
{
311290
title: 'Write the docs',
312291
sidebarDepth: 1,
@@ -322,14 +301,12 @@ module.exports = {
322301
'/project/repository-guide',
323302
'/project/related-projects',
324303
'/project/implementation-status',
325-
['https://github.com/ipfs/roadmap', 'Roadmap'],
326304
['https://github.com/ipfs/specs', 'Specifications'],
327-
['https://github.com/ipfs/research', 'Research'],
328-
['https://github.com/ipfs/team-mgmt', 'Team org planning'],
305+
['/concepts/further-reading/academic-papers', 'Research'],
329306
[
330307
'https://github.com/ipfs/community/blob/master/code-of-conduct.md',
331308
'Code of conduct'
332-
]
309+
],
333310
],
334311
'/case-studies/' : [
335312
{

docs/.vuepress/redirects

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
/basics/go/command-line-quick-start /how-to/command-line-quick-start
44
/basics/js/js-ipfs /install/js-ipfs
55
/basics/ipfs-implementations /concepts/ipfs-implementations
6+
/community/chat /community
67
/community/contribute/ /project/contribute
78
/community/contribute/how-to-help/ /project/contribute
89
/concepts/privacy /concepts/privacy-and-encryption

docs/community/README.md

Lines changed: 97 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,133 @@
11
---
22
title: Community
33
description: Become part of the IPFS community! Learn how here.
4+
sidebarDepth: 3
45
---
56

67
# Community
78

89
IPFS is home to a vibrant, diverse community of thousands of contributors and participants from all over the globe! Here's how to get help, support, or just hang out with other folks who are helping to build the distributed web.
910

10-
## IPFS newsletter
1111

12-
Sign up for the IPFS Weekly newsletter to get project updates, community news, event details, and more. In your inbox every Tuesday. [Subscribe now!](https://ipfs.us4.list-manage.com/subscribe?u=25473244c7d18b897f5a1ff6b&id=cad54b2230)
12+
:::callout
13+
The IPFS community believes that our mission is best served in an environment that is friendly, safe, and accepting, and free from intimidation or harassment. To that end, we ask that everyone involved in IPFS read and respect our [code of conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). Please contact [abuse@ipfs.io](mailto:abuse@ipfs.io) if you need to report a problem or address a grievance related to an abuse report.
14+
:::
1315

14-
## Ways to contribute
16+
- [Get technical support and help in the IPFS forum](#get-technical-support-and-help) as you develop on IPFS.
17+
- Get involved with the community through [apps like Discord and Slack](#chat), regularly occurring [community events such as demos and triage sessions](#community-events-calendar), and [the IPFS forum](#ipfs-forums).
18+
- Stay informed and up to date on the latest developments in the IPFS ecosystem with [social media](#social-media) and [the IPFS newsletter](#ipfs-newsletter).
19+
- Navigate the IPFS ecosystem using [the ecosystem directory](#ecosystem-directory) and [Awesome IPFS](#awesome-ipfs).
1520

16-
No matter your area of specialty or level of expertise, there are many [ways to contribute](contribute/ways-to-contribute.md) to IPFS and make a real difference in the IPFS community at large.
21+
## Get technical support and help
22+
23+
Are you developing with IPFS implementations and tools, and looking for technical support from IPFS experts? For the fastest possible assistance and resolution of your support needs, do the following:
24+
25+
1. [Check to see if the problem / issue you've encountered has already been discussed](#_1-check-to-see-if-the-issue-you-ve-encountered-has-already-been-discussed).
26+
2. If your problem / issue has not been discussed or solved in the forum, [follow the general guidelines for getting useful answers to your questions](#_2-follow-the-guidelines-for-getting-useful-answers-to-your-questions).
27+
3. [Create a forum post in the Help section](#_3-create-a-forum-post-in-the-help-section).
28+
29+
:::tip
30+
To post in the IPFS forum, you'll need a (free) IPFS forum account if you don't already have one. To create an account, click the **Sign Up** button in the top right corner of the forum website.
31+
:::
32+
33+
### 1. Check to see if the issue you've encountered has already been discussed
34+
35+
1. Navigate to [the Help category of the IPFS forum](https://discuss.ipfs.tech/c/help/13).
36+
1. In the upper right hand corner, click the search icon (a blue magnifying glass). The forum search bar opens.
37+
1. In the search bar, type a term related to the issue you are trying to solve. Options to either search the Help category or search all forum topics and posts display.
38+
1. Below the search bar, click the option to search for the term in the Help channel. Alternatively, you can search across all topics and posts. A list of forum posts related to your search displays.
39+
1. Search through the list of posts returned. If you don't find the answer or help you're looking for, [follow the general guidelines for getting useful answers to your questions](#2-follow-the-guidelines-for-getting-useful-answers-to-your-questions).
40+
41+
### 2. Follow the guidelines for getting useful answers to your questions
1742

18-
## IPFS forums
43+
Please following these general guidelines when asking for help:
1944

20-
The official [IPFS forums](https://discuss.ipfs.tech/) are the primary home of IPFS-related discussion. Join the conversation on [https://discuss.ipfs.tech](https://discuss.ipfs.tech) for everything from technical questions, project brainstorming, talk on IPFS use cases, and more.
45+
- Before creating a forum post, summarize the issue / problem you are encountering. Example phrasings:
46+
- _Here's what I'm trying to do..._
47+
- _I did X and expected Y to happen..._
48+
- _Could this be because...?_
49+
- _This seems impossible because..._
50+
- _I've tried A, B and C to fix X, but..._
51+
- When asking for help with one of the IPFS libraries, include the name of the exact package and version of the package/library.
52+
- When sharing bits of code, [use markdown](../community/contribute/grammar-formatting-and-style.md#style) to format code blocks so that they are easier to read.
53+
- Ensure that you've read the forum [FAQ](https://discuss.ipfs.tech/faq) and [Terms of Service](https://discuss.ipfs.tech/tos).
54+
- Screenshots of errors are often helpful.
2155

22-
## Chat
56+
### 3. Create a forum post in the Help section
2357

24-
Casual chat fan? Here are [all our channels](chat.md). There's getting-started advice for you here, too.
58+
Keeping in mind [the general guidelines above](#_2-follow-the-guidelines-for-getting-useful-answers-to-your-questions), do the following:
2559

26-
## Community Calendar
60+
1. In [the Help category of the forum](https://discuss.ipfs.tech/c/help/13), hover over the large blue circle with a `+` symbol in the center. The text **New Topic** displays.
61+
1. Click **New Topic**. The **Create a new Topic** modal opens.
62+
1. In the title field, describe what the discussion is one brief sentence.
63+
1. Add any optional tags that help describe what subcategory the issue is in. Samples options include `go-ipfs` and `js-ipfs`.
64+
1. Following the guidelines above, describe your issue / problem in the main text field. You can use Markdown, BBCode or HTML for formatting, and include images.
65+
1. Click **Create Topic**. Your topic is has been created in the forum!
66+
67+
The forum moderators will attempt to address your post as quickly as possible.
68+
69+
## Get involved
70+
71+
### IPFS forums
72+
73+
The official [IPFS forums](https://discuss.ipfs.tech/) are the primary home of IPFS-related discussion. Join the conversation on [https://discuss.ipfs.tech](https://discuss.ipfs.tech) for everything from support, technical questions, project brainstorming, IPFS use cases, and more.
74+
75+
### Community Events Calendar
2776

2877
If you're an IPFS implementer, application developer, or user, you are welcome to join the community meetings we host regularly.
2978

3079
Stay up-to-date by subscribing to the [**IPFS Community Calendar**](https://ipfs.fyi/calendar) and joining community meetings such as triage sessions, the IPFS implementers sync, and the IPLD sync.
3180

32-
## ProtoSchool workshops
81+
### Chat
82+
83+
Casual chat fan? You can engage with the IPFS community in one of the channels listed below:
84+
85+
:::callout
86+
In general, public IPFS Discord channels are bridged to Matrix and Slack. As a result, you can usually use your preferred chat application to engage with the community. IPFS channels/rooms are usually prefixed with "#ipfs-".
87+
:::
3388

34-
ProtoSchool isn't just home to interactive tutorials on the decentralized web — it's also a vibrant community of makers and doers around the globe! Community groups worldwide host [ProtoSchool workshops](https://proto.school/events) regularly, offering you the opportunity to complete our interactive tutorials with the support of local mentors.
89+
- **Discord**: Join the [IPFS Discord server](https://discord.gg/ipfs) for synchronous chat.
3590

36-
## Meetups
91+
- **Matrix**: Join the [Matrix space](https://matrix.to/#/#ipfs-space:ipfs.io).
92+
93+
- **Slack**: Join [Filecoin slack](https://filecoin.io/slack) and join the bridged #ipfs channels.
94+
95+
### Meetups
3796

3897
IPFS meetups are also all over the world. [Find one close to you](https://www.meetup.com/members/249142444/) ... or [contact IPFS Community on Meetup.com](https://secure.meetup.com/messages/?new_convo=true&member_id=249142444&name=IPFS+Community) to start your own in your area!
3998

40-
## Social media
99+
### Contribute
100+
101+
No matter your area of specialty or level of expertise, there are many [ways to contribute](contribute/ways-to-contribute.md) to IPFS and make a real difference in the IPFS community at large.
102+
103+
104+
## Stay informed
105+
106+
### Social media
41107

42108
We're in a lot of places. Here's [how to find them all](social-media.md) for your favorite platforms.
43109

44-
## Ecosystem directory
110+
### IPFS newsletter
111+
112+
Sign up for the IPFS Weekly newsletter to get project updates, community news, event details, and more. In your inbox every Tuesday. [Subscribe now!](https://ipfs.us4.list-manage.com/subscribe?u=25473244c7d18b897f5a1ff6b&id=cad54b2230)
113+
114+
### IPFS Blog
115+
116+
The latest updates and info on IPFS in one place, from blog posts and release notes to videos, tutorials, news coverage, and events.
117+
[Read the blog here](https://blog.ipfs.io/).
118+
119+
### YouTube
120+
121+
Learn more about IPFS in [the official IPFS YouTube channel](https://www.youtube.com/channel/UCdjsUXJ3QawK4O5L1kqqsew). It has lots of great educational material around IPFS.
122+
123+
## Navigate the IPFS ecosystem
124+
125+
### Ecosystem directory
45126

46127
Explore the world of projects and products built on IPFS in the [Ecosystem directory](https://ecosystem.ipfs.io/) – an interactive showcase filterable by industry, tooling, and more.
47128

48129
If you want to add a new project to the IPFS ecosystem directory, use [this form](https://airtable.com/shrjwvk9pAeAk0Ci7).
49130

50-
## Awesome IPFS
131+
### Awesome IPFS
51132

52-
Get inspired by [Awesome IPFS](https://awesome.ipfs.tech/), a catalog of community-built open-source projects using IPFS for everything from image sharing to decentralized archiving. Have a project of your own to add to Awesome IPFS? Make a PR [in the repo!](https://github.com/ipfs/awesome-ipfs).
133+
Get inspired by [Awesome IPFS](https://awesome.ipfs.tech/), a catalog of community-built open-source projects using IPFS for everything from image sharing to decentralized archiving. Have a project of your own to add to Awesome IPFS? Make a PR [in the repo!](https://github.com/ipfs/awesome-ipfs).

docs/community/contribute/ways-to-contribute.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ description: Learn about how to contribute to IPFS, the InterPlanetary File Syst
77

88
So you want to contribute to IPFS and the ecosystem? Here is a quick listing of things we need help with and how you can get started. Even if what you want to do is not listed here, we probably accept contributions for it! If you're unsure, please open an issue.
99

10+
:::callout
11+
The IPFS community believes that our mission is best served in an environment that is friendly, safe, and accepting, and free from intimidation or harassment. To that end, we ask that everyone involved in IPFS read and respect our [code of conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). Please contact [abuse@ipfs.io](mailto:abuse@ipfs.io) if you need to report a problem or address a grievance related to an abuse report.
12+
:::
13+
1014
## Code
1115

1216
IPFS and its sister-projects are big, with lots of code written in multiple languages. We always need help writing and maintaining code, but it can be daunting to just jump in. We use the label _Help Wanted_ on features or bug fixes that people can help out with. They are an excellent place for you to start contributing code.

docs/how-to/command-line-quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,4 +265,4 @@ You need to install and set up FUSE in order to mount the file system. For more
265265
266266
### Further help
267267
268-
The IPFS community is friendly and able to help! Get support from other IPFS developers in the official [IPFS forums](https://discuss.ipfs.tech/), or join [community chat channels](../community/chat.md).
268+
The IPFS community is friendly and able to help! [Get support from other IPFS developers in the IPFS forum](../community/README.md#get-technical-support-and-help), or join [community chat channels](../community/README.md#chat).

docs/project/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ description: Learn about the history, roadmap, current status and more for IPFS,
55

66
# The IPFS project
77

8-
Curious about how it all got started, or where we're headed? Learn about the history, current state, and future trajectory of the IPFS project here.
8+
Looking to get further involved with the vibrant IPFS community and ecosystem? Curious about how it all got started, or where we're headed? Learn how to get involved, the project history, and more.
9+
10+
## IPFS community and ecosystem
11+
12+
:::callout
13+
The IPFS community believes that our mission is best served in an environment that is friendly, safe, and accepting, and free from intimidation or harassment. To that end, we ask that everyone involved in IPFS read and respect our [code of conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). Please contact [abuse@ipfs.io](mailto:abuse@ipfs.io) if you need to report a problem or address a grievance related to an abuse report.
14+
:::
15+
16+
The community and ecosystem around the IPFS project is large, diverse, and abounds with opportunities for involvement. Learn more in the [Community section](../community/README.md).
917

1018
## History of IPFS
1119

@@ -15,10 +23,6 @@ Want to know how it all began? Learn the [history of the IPFS project](history.m
1523

1624
IPFS is a big project, which means there are a lot of GitHub repos. If you're new to IPFS or just want a sense of what to check out first, use this quick guide to the most important and most frequently used [IPFS repositories](repository-guide.md).
1725

18-
## Roadmap
19-
20-
See the overall roadmap of [IPFS project requirements](https://github.com/ipfs/roadmap) from current state to maturity.
21-
2226
## Implementation status
2327

2428
Want to know the current state of your favorite IPFS feature? See the [current implementation status](implementation-status.md) for Kubo and js-ipfs, listed by commands and endpoints.
@@ -38,7 +42,3 @@ IPFS is a highly modular project that is itself made out of many different proto
3842
## Contribute to IPFS
3943

4044
Thousands of people contribute to IPFS from all over the world — and that can include you! No matter your areas of interest or expertise, there are a number of ways that you can make an impact on the future of the Internet by [contributing to IPFS](../community/contribute/ways-to-contribute.md).
41-
42-
## Code of conduct
43-
44-
The IPFS community believes that our mission is best served in an environment that is friendly, safe, and accepting, and free from intimidation or harassment. To that end, we ask that everyone involved in IPFS read and respect our [code of conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

0 commit comments

Comments
 (0)