Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for federation overview (fixes #774) #1165

Merged
merged 1 commit into from
Oct 2, 2020

Conversation

Nutomic
Copy link
Member

@Nutomic Nutomic commented Oct 1, 2020

Creating this PR on Github instead of Gitea as it seems relevant to a lot more people than just code.

This is roughly based on a suggestion from the SocialHub Forum. I made some adjustments to the format to avoid duplicate content, and to better describe how Lemmy works.

This document is targeted at people that are more or less familiar with ActivityStreams and ActivityPub protocols. It is meant provide a high-level overview of ActivityPub federation in Lemmy.

Copy link
Member

@dessalines dessalines left a comment

Choose a reason for hiding this comment

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

A few things

docs/src/contributing_federation_overview.md Outdated Show resolved Hide resolved
docs/src/contributing_federation_overview.md Outdated Show resolved Hide resolved
docs/src/contributing_federation_overview.md Outdated Show resolved Hide resolved
docs/src/contributing_federation_overview.md Outdated Show resolved Hide resolved
docs/src/contributing_federation_overview.md Show resolved Hide resolved
@Nutomic Nutomic force-pushed the federation-overview branch from d6ece18 to 04aacf1 Compare October 2, 2020 11:33
@Nutomic
Copy link
Member Author

Nutomic commented Oct 2, 2020

Updated to address your comments, and I also rewrite the "federation philosphy" section.

I am also wondering whether we should add a more detailed explanation of how moderation works. As well as the instance blocklist/allowlist. But those might fit better into the administration docs.

Do you think its good to capitalise the terms "Community", "Comment" etc like this? And is there too much duplicate info, or any info missing?

@dessalines
Copy link
Member

I am also wondering whether we should add a more detailed explanation of how moderation works. As well as the instance blocklist/allowlist. But those might fit better into the administration docs.

It seems good to me, we're still kinda working out federated moderation anyway. Capitalization is fine too, especially since they're concepts. I'll merge and we can refine it later if necessary.

@dessalines dessalines merged commit e596ea6 into main Oct 2, 2020
@dessalines dessalines deleted the federation-overview branch April 7, 2021 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants