The section “From remote viewing to adding remotes” could use some clarifying language.
The section “From remote viewing to adding remotes” could use some clarifying language.
What is meant by allow policy? It’s the first time that it’s introduced and there’s no other mention of it in the guide.
From what I understand there are three key aspects:
scope: eitherfollowedoralland defined per repo- The follow list of the node (which is updated either via
rad followorrad remote add) - the delegates (whose changes are synched irrespective of the scope)
The first two are within the user’s control, where as the delegates is defined by the repo.
What is meant by
allowpolicy? It’s the first time that it’s introduced and there’s no other mention of it in the guide.
Right, I see halfway up the document “seeding policy” is mentioned,
but the all value is never introduced.
It might be natural to introduce it there.
It might be even better to have a section on policies, seeding, and following.
It might be even better to have a section on policies, seeding, and following.
I agree
Changes:
- Added a section on policies – removing the note that mentioned adding such a section.
REVIEW per commit
They are all small language nits
- REVIEW: guides/user: add section on policies
- REVIEW: guides/user: clarify the policy and scope of init and clone
Policing sounds a bit harsh. What do you think about changing the title to “Moderation Policies” or “Replication Policies” and emphasise that they are defined locally for your node.
Besides that I’d recommend breaking this into bullet points for easier readability:
A seeding policy can be broken down into two components, which are defined locally per Repo ID:
- Policy: whether the nodes allows or blocks the repository from being fetched and can either be set to
allowandblock.- Scope can be one of two values:
allorfollowed.
- The
allscope means that all references of all peer’s namespaces within a repository are fetched.- The
followedscope means that only references from your followed peers are fetched. We will discuss what we mean by “followed peers” in just a moment.
REVIEW: guides/user: add section on policies
REVIEW: guides/user: clarify the policy and scope of init and clone
refine section on policies
Changes:
- Accept review commits from levitte and 2color
Rebase and review.
I think that in the meantime the default scope has changed from “all” to “followed”, right? If so, this needs an update.