Skip to content

Conversation

@ElPaisano
Copy link
Contributor

@ElPaisano ElPaisano commented Feb 1, 2023

Draft 👉 https://bafybeibiyrgmm6xz4p3lyhhuyklzrqpojhjdni5422nrtkjedcxyunowse.on.fleek.co/

A second refactor of the Projects / Community section and sidebar menu. Addresses:

  1. Restructures community page into different groups -> https://bafybeibiyrgmm6xz4p3lyhhuyklzrqpojhjdni5422nrtkjedcxyunowse.on.fleek.co/community/
  2. Improve documentation experience related to user support #1469 adds a section getting dev support -> https://bafybeibiyrgmm6xz4p3lyhhuyklzrqpojhjdni5422nrtkjedcxyunowse.on.fleek.co/community/#get-technical-support-and-help
  3. Removes outdated community links (ProtoSchool isn't really a thing anymore, some repos in the main sidebar are no longer active) -> the Projects section sidebar and https://bafybeibiyrgmm6xz4p3lyhhuyklzrqpojhjdni5422nrtkjedcxyunowse.on.fleek.co/community/
  4. Shuffles sidebar menu items around
  5. Adds notes to a few pages about code of conduct and reporting abuse community section update + add stuff about support #1473 (comment)

Goals of this PR:

  • Improve navigability
  • Improve grouping
  • Improve sidebar menu options
  • Remove outdated / items
  • Remove as many outbound links from the sidebar menus as possible (bad user experience)
  • Add info on getting tech / dev support

Checklist before requesting a review

  • Passing the beta version of the Check Markdown links for modified files check. Action results can be viewed here.

Checklist before merging

  • Passing all required checks (The beta Check Markdown links for modified files check is not required)

@ElPaisano ElPaisano self-assigned this Feb 1, 2023
@ElPaisano ElPaisano added this to the 1/27/23 - 2/3/23 milestone Feb 1, 2023
@ElPaisano ElPaisano linked an issue Feb 1, 2023 that may be closed by this pull request
@ElPaisano
Copy link
Contributor Author

ElPaisano commented Feb 1, 2023

@ElPaisano ElPaisano marked this pull request as ready for review February 1, 2023 22:44
- **Discord**: Join the [IPFS Discord server](https://discord.gg/ipfs) for synchronous chat! [Server documentation can be found on Notion](https://pl-strflt.notion.site/IPFS-Discord-Server-Documentation-85bbc451303a473bbf6846b01610e3c1).

## Meetups
- **Matrix**: Join the [Matrix space](https://matrix.to/#/#ipfs-space:ipfs.io). [Home server documentation is available on Notion](https://pl-strflt.notion.site/IPFS-Matrix-Homeserver-Documentation-31481e76843547b7ab5160a87eed2b9f).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the notion page is public

## Meetups
- **Matrix**: Join the [Matrix space](https://matrix.to/#/#ipfs-space:ipfs.io). [Home server documentation is available on Notion](https://pl-strflt.notion.site/IPFS-Matrix-Homeserver-Documentation-31481e76843547b7ab5160a87eed2b9f).

- **Slack**: Join [Filecoin slack](https://filecoin.io/slack) and join the bridged #ipfs channels. The [Filecoin Slack workspace user guide is available on Notion](https://pl-strflt.notion.site/Filecoin-Slack-User-Guide-29072679986b4ccb8ad7b091097dd770).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this notion page is public either

:::

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.
- **Discord**: Join the [IPFS Discord server](https://discord.gg/ipfs) for synchronous chat! [Server documentation can be found on Notion](https://pl-strflt.notion.site/IPFS-Discord-Server-Documentation-85bbc451303a473bbf6846b01610e3c1).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here — Notion page isn't meant to be public

'/project/repository-guide',
'/project/related-projects',
'/project/implementation-status',
['https://github.com/ipfs/roadmap', 'Roadmap'],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we removing the link to the roadmap?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not clear to me that this repo is still being used. Last commit was end of October. Is this repo no longer being used for roadmap stuff? Aren't roadmaps individualized to a product now?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess that was arising from my naive hope that the roadmap would actually be updated.

Yeah, let's remove it for now.

'https://github.com/ipfs/community/blob/master/code-of-conduct.md',
'Code of conduct'
]
['https://github.com/ipfs/notes', 'Research'],
Copy link
Member

@2color 2color Feb 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should link to the docs Academic papers page rather than https://github.com/ipfs/notes

['https://github.com/ipfs/specs', 'Specifications'],
['https://github.com/ipfs/research', 'Research'],
['https://github.com/ipfs/team-mgmt', 'Team org planning'],
[
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would still leave the link to the code of conduct in the sidebar menu.

'https://github.com/ipfs/community/blob/master/code-of-conduct.md',
'Code of conduct'
],
['https://github.com/ipfs/notes', 'Research'],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@2color 2color left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

The main feedback would be to leave the sidebar link to the code of conduct.

@ElPaisano
Copy link
Contributor Author

@2color other than the roadmap repo, I think 809e722 addresses the rest of your feedback

@ElPaisano
Copy link
Contributor Author

Confirming that this PR has no spelling issues (Vale is flagging special terms, need to update word list) or broken links

@ElPaisano ElPaisano merged commit 7a710b9 into ipfs:main Feb 2, 2023
@ElPaisano
Copy link
Contributor Author

@TMoMoreau @TheDiscordian since this has already had one approving review / been checked fro the writing things, I'm going to ship this as is. Please feel free to comment here if you have any other concerns and I'll address them

@ElPaisano
Copy link
Contributor Author

@walkerlj0 didn't get a chance to mention this in the working group - this PR (merged) updates https://docs.ipfs.tech/community/

TLDR:

  • Adds info on getting tech support
  • Rearranges menu items
  • Removes outdated items and copy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation experience related to user support

2 participants