Page MenuHomeSoftware Heritage

Add a quick presentation/architecture doc on the mirror
ClosedPublic

Authored by zack on Dec 18 2020, 1:46 PM.

Diff Detail

Repository
rDDOC Development documentation
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

vlorentz added inline comments.
docs/mirror.rst
20–21

and the public API

66–71

why are they in a separate list?

74

s/need/needs/

75

s/relialably/reliably/

76

s/hoste/hosted/

This revision now requires changes to proceed.Dec 21 2020, 2:54 PM
zack added a reviewer: douardda.
  • doc index: improve short descriptions of entry points
  • mirror doc: full reread with improvements here and there
zack marked 5 inline comments as done.
zack added inline comments.
docs/mirror.rst
66–71

i've improved the description to make it clearer why they're described separately (first list is the archive, second metadata about them), but also said explicitly that all topics should be mirrored

docs/mirror.rst
66–71

I don't see why we're making this difference. Metadata are an integral part of the archive; even more so than visits or visit statuses.

  • mirror doc: merge all topics in a single list
zack added inline comments.
docs/mirror.rst
66–71

ufff.... ok, merged.

This revision is now accepted and ready to land.Dec 23 2020, 1:43 PM
  • mirror doc: full reread with improvements here and there
  • doc index: improve short descriptions of entry points
  • mirror doc: full reread with improvements here and there