Customizing OrbitDB Chapter added #132

CSDUMMI · 2021-05-20T13:12:10Z

I refer to #131 for further details on this PR.

…ntroduction added. Thus the introduction content is finished.

…file names independently.

…dex.

…ys section.

Chapters about the ACL are now an Appendix.

05_Customizing_OrbitDB/07_Implementing_a_custom_AccessController.md

aphelionz

This looks fantastic and I'm really excited to get it merged.

Here's the first batch of mostly grammatical issues. Have to go afk for a bit but I'll be back to it soon. Overall - review the rules for commas and when in doubt exclude them: https://www.btb.termiumplus.gc.ca/tpv2guides/guides/pep/index-eng.html?lang=eng&page=punct_2_commas_that_clutter

05_Customizing_OrbitDB/00_Introduction.md

05_Customizing_OrbitDB/02_Choosing_a_data_structure.md

05_Customizing_OrbitDB/03_Defining_the_Index.md

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

aphelionz

Last batch of comments! Looking better and better.

Also, why were the dist files deleted?

aphelionz · 2021-05-31T20:46:39Z

05_Customizing_OrbitDB/01_Definitions.md

+
+It is setup when you create a database
+and stored in the Manifest of the database.
+(That thing, that the mulithash in the middle


Not really but you can perhaps placeholder the hash

aphelionz · 2021-05-31T20:47:05Z

05_Customizing_OrbitDB/01_Definitions.md

+
+But this also means, you cannot modify your access
+controller and it's options after you created
+the database.


Gotcha, maybe specify you're talking about the AC type, or method

05_Customizing_OrbitDB/03_Defining_the_Index.md

05_Customizing_OrbitDB/06_AccessControllers.md

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

To make clear, that you cannot change the AC type after the creation of a db. Also used an example address.

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

CSDUMMI

Last batch of comments! Looking better and better.

Also, why were the dist files deleted?

If we use CD Actions, we shouldn't need them. But we could put it back.

05_Customizing_OrbitDB/01_Definitions.md

CSDUMMI · 2021-05-31T20:04:59Z

05_Customizing_OrbitDB/02_Choosing_a_data_structure.md

+these trees from the oplog or `ipfs-log`.
+
+In the index, we'll see the oplog as an
+Array of operations, each containing these fields:


I wanted to use Array because I thought the oplog passed to the Index is of type Array.
This isn't the case?

CSDUMMI · 2021-05-31T20:14:54Z

05_Customizing_OrbitDB/02_Choosing_a_data_structure.md

+by choosing how we want to represent the
+comments in the Index.
+
+By choosing a data structure and


I tried to change this a bit.
No by using a numbered list, because that would have been very repetitive.

05_Customizing_OrbitDB/03_Defining_the_Index.md

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

CSDUMMI and others added 30 commits May 20, 2021 15:11

Customizing OrbitDB Chapter added

cfc32c8

Added TOC

6c0a64b

Links added to setup the basic structure of the chapter.

8a41453

Adding stubs of the files used in the structure of the chapter.

5c85864

Section on what we will implement.

89cd503

What do you need to read to understand this chapter? section in the i…

c51c764

…ntroduction added. Thus the introduction content is finished.

Link to the next part added.

986f5b6

Definitions added

b339762

code_examples from the last part of the code examples copied.

9a27281

NoteStore.js added

4b5371c

Section on advantages and disadvantages of custom stores.

db1921f

Changed name of 4 subchapter.

5c88b9b

02_The_Store.md completed.

c0d7143

don't provide the name in the code_examples to be able to modify the …

fe6ab7c

…file names independently.

The Store as an Interface

214bbc0

source code final folder added

654e5ad

Draft 1 of "The Store as an Interface" written

85384cb

NotesStore adding Index to options.

de1e112

Trying to implement the NotesIndex.js

b503887

DEL operation added

c0a5a22

exporting of NotesIndex added

dc6b900

Added the notespiecesplease.js file to final.

5b77f34

New second chapter added about the data structure used in the NotesIn…

aeb86b7

…dex.

Defining the Index Chapter.

6e9b996

NotesIndex: added updateIndex skeleton.

94bddf2

bold style

fd362a7

Finished the 03_Defining_the_Index.md chapter.

9acc78c

Minor spelling correction.

8754063

Defining get functions on the store.

14a1578

Adding data section on Defining the Store added

bd620ab

CSDUMMI and others added 10 commits May 26, 2021 20:54

draft v1 of the Defining the Store chapter finished with key take awa…

3a33854

…ys section.

AccessControllers added chapter.

4e1d983

Section about the complexities of AccessControllers added

dfe2d00

Sixth chapter for actually implementing an Access Controllers

037bd70

Notice added about the ACL shorthand

e784b85

CC-BY-NC and not CC-BY-NC-ND

ff1cc5c

MIT License in code_examples

5d5edb6

ignoring orbitdb and jsipfs folders

1337a9d

Wrote a conclusion to the main part of my Part 5 of the FM.

42221d1

Chapters about the ACL are now an Appendix.

Notice of the state of the Field Manual.

d3d3163

djmaze reviewed May 30, 2021

View reviewed changes

05_Customizing_OrbitDB/07_Implementing_a_custom_AccessController.md Outdated Show resolved Hide resolved

aphelionz requested changes May 31, 2021

View reviewed changes

CSDUMMI and others added 8 commits May 31, 2021 20:29

Typo

d3b5c6a

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

Removed unnecessary line

89c0a21

note sharing -> sheet music

9dbbddc

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

Removing commas.

c2eaf7f

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

Applied typographic and grammar suggestions

ec1bc4c

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

Delete heuristic idea for further ideas

550c53f

Run-on-sentence changed.

79c7a02

The Index stores in the RAM

034c763

aphelionz requested changes May 31, 2021

View reviewed changes

CSDUMMI and others added 3 commits June 1, 2021 07:52

Update 05_Customizing_OrbitDB/03_Defining_the_Index.md

04d6a70

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

Reformulated the AC description

b0afd6c

To make clear, that you cannot change the AC type after the creation of a db. Also used an example address.

Apply simple suggestions from code review

cd36c2a

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

CSDUMMI commented Jun 1, 2021

View reviewed changes

CSDUMMI and others added 3 commits June 1, 2021 17:37

Apply suggestions from code review

d0784ff

Co-authored-by: Mark Robert Henderson <henderson.mark@gmail.com>

Dropping paragraph

4a414c9

Removed opening code block

f617823

aphelionz approved these changes Jun 1, 2021

View reviewed changes

aphelionz merged commit 0008466 into orbitdb:main Jun 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Customizing OrbitDB Chapter added #132

Customizing OrbitDB Chapter added #132

CSDUMMI commented May 20, 2021

aphelionz left a comment

aphelionz left a comment

aphelionz May 31, 2021

aphelionz May 31, 2021

CSDUMMI left a comment

CSDUMMI May 31, 2021

CSDUMMI May 31, 2021

Customizing OrbitDB Chapter added #132

Customizing OrbitDB Chapter added #132

Conversation

CSDUMMI commented May 20, 2021

aphelionz left a comment

Choose a reason for hiding this comment

aphelionz left a comment

Choose a reason for hiding this comment

aphelionz May 31, 2021

Choose a reason for hiding this comment

aphelionz May 31, 2021

Choose a reason for hiding this comment

CSDUMMI left a comment

Choose a reason for hiding this comment

CSDUMMI May 31, 2021

Choose a reason for hiding this comment

CSDUMMI May 31, 2021

Choose a reason for hiding this comment