Radish alpha
r
rad:z371PVmDHdjJucejRoRYJcDEvD5pp
Radicle website including documentation and guides
Radicle
Git
Clarify Language in User Guide
Open fintohaps opened 3 months ago

The section “From remote viewing to adding remotes” could use some clarifying language.

fintohaps opened with revision 83fbdf33 on base 110e29b6 +10 -5 3 months ago

The section “From remote viewing to adding remotes” could use some clarifying language.

2color commented on revision 1 3 months ago

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: either followed or all and defined per repo
  • The follow list of the node (which is updated either via rad follow or rad 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.

fintohaps commented on revision 1 3 months ago

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.

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.

2color commented on revision 1 3 months ago

It might be even better to have a section on policies, seeding, and following.

I agree

fintohaps pushed revision 2 05b33c80 on base 110e29b6 +52 -7 3 months ago

Changes:

  • Added a section on policies – removing the note that mentioned adding such a section.
levitte pushed revision 3 6bf4a450 on base 110e29b6 +52 -7 3 months ago

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
2color commented on revision 3 3 months ago

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:

  1. Policy: whether the nodes allows or blocks the repository from being fetched and can either be set to allow and block.
  2. Scope can be one of two values: all or followed.
    • The all scope means that all references of all peer’s namespaces within a repository are fetched.
    • The followed scope means that only references from your followed peers are fetched. We will discuss what we mean by “followed peers” in just a moment.
2color pushed revision 4 174b9e9a on base 110e29b6 +47 -7 3 months ago

REVIEW: guides/user: add section on policies

REVIEW: guides/user: clarify the policy and scope of init and clone

refine section on policies

fintohaps pushed revision 5 98c56710 on base 110e29b6 +47 -7 3 months ago

Changes:

  • Accept review commits from levitte and 2color
lorenz pushed revision 6 17bb631f on base 949a8701 +47 -5 6 days ago

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.