Radish alpha
r
Radicle website including documentation and guides
Radicle
Git (anonymous pull)
Log in to clone via SSH
Clarify Language in User Guide
did:key:z6MkireR...3voM wants to merge 3 commits into master · opened 4 months ago

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

did:key:z6MkireR...3voM opened with revision 83fbdf33b783991691e41656528bb47d2a3cf11c on base 110e29b65c365c1b6623d76f93483c4b4bd317f4 +10 -5 4 months ago
2color commented on revision 1 4 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.

did:key:z6MkireR...3voM commented on revision 1 4 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 4 months ago

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

I agree

did:key:z6MkireR...3voM pushed revision 2 05b33c808c7bf57815c05e89a6aaf67f44978ea4 on base 110e29b65c365c1b6623d76f93483c4b4bd317f4 +52 -7 4 months ago

Changes:

  • Added a section on policies – removing the note that mentioned adding such a section.
levitte pushed revision 3 6bf4a450dddbdd11b441bc8a0888a83ac9806a35 on base 110e29b65c365c1b6623d76f93483c4b4bd317f4 +52 -7 4 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 4 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 174b9e9a11d60b035f5743379f40405113c4bdfb on base 110e29b65c365c1b6623d76f93483c4b4bd317f4 +47 -7 4 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

did:key:z6MkireR...3voM pushed revision 5 98c567107b7b10720bc6732e7417e7a771d342c7 on base 110e29b65c365c1b6623d76f93483c4b4bd317f4 +47 -7 4 months ago

Changes:

  • Accept review commits from levitte and 2color
2color pushed revision 6 deef414a007f43188648ba53f84d962cfd266426 on base 110e29b65c365c1b6623d76f93483c4b4bd317f4 +47 -7 4 months ago

typos and further refinement

2color pushed revision 7 3907f5b26015240029e1a0ad819749fa2bd3a9f3 on base 110e29b65c365c1b6623d76f93483c4b4bd317f4 +47 -7 4 months ago

typos and further refinement

lorenz pushed revision 8 17bb631f7e63d98dba275c11d9961aff8597c7e1 on base 949a870164d097848c131be078cb5419b61d4c4b +47 -5 27 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.

did:key:z6MkireR...3voM pushed revision 9 082358837062de789decb15ac350d333c071cfd6 on base 0fd32c41515c1fbaea69a3bce122c6fda162cefb +47 -5 10 days ago

Changes:

  • Rebase
  • Fix grammar in policy section