small comments for the documents while reading them

[Jia Zhai]

The documents is so detailed and really help a lot for getting familiar with DistributedLog. :)
There are some small comments while reading them. If there is anything wrong, please forgive me as a newbie.

In http://distributedlog.io/html/tutorials/main.html

At the beginning, "Tutorials are useful for showing how DistributedLog is used in read-world applications, especially when it comes to integrating with other systems."

Here read-world may should be real-world.

 

In http://distributedlog.io/html/basics/introduction.html

in Figure 2, 

at the top-left, there is a word LSSN, which may be "Log Segment Sequence Number", not explicted explained. 

at the top-right, there are 3 word "DLSN", "Sequence ID", "Transaction ID" next to "record 1". This seems like each record has these 3 IDs. While, By reading the introduction, there seems each record has 2 ID,  both "DLSN" and "Transaction ID" that could served as a "Sequence ID".

[Sijie Guo]

On Friday, May 13, 2016 at 8:13:40 AM UTC-7, Jia Zhai wrote:

The documents is so detailed and really help a lot for getting familiar with DistributedLog. :)
There are some small comments while reading them. If there is anything wrong, please forgive me as a newbie.

In http://distributedlog.io/html/tutorials/main.html

At the beginning, "Tutorials are useful for showing how DistributedLog is used in read-world applications, especially when it comes to integrating with other systems."

Here read-world may should be real-world.

Do you mind sending a pull request for fixing that? The text in README.md of https://github.com/twitter/distributedlog/tree/master/distributedlog-tutorials

 

 

In http://distributedlog.io/html/basics/introduction.html

in Figure 2, 

at the top-left, there is a word LSSN, which may be "Log Segment Sequence Number", not explicted explained. 

at the top-right, there are 3 word "DLSN", "Sequence ID", "Transaction ID" next to "record 1". This seems like each record has these 3 IDs. While, By reading the introduction, there seems each record has 2 ID,  both "DLSN" and "Transaction ID" that could served as a "Sequence ID".

Yes. there are 3 ID associated with a record.

Transaction ID: application provided sequence number. it is usually timestamp.

DLSN: Distributed Log Sequence Number. It is system generated sequence number. It is typically used for fast looking up, positioning and truncation. It is comprised with LSSN (Log Segment Sequence Number), Entry Id and Slot Id. It can be used to determine the ordering of two records. 

SequenceID is an monotonically increasing long number starting from 0. Applications can tell how many records between two records by just comparing their sequence ids.

Hope this answer your question. If you could create a github issue, I could update the documents.

- Sijie

[Jia Zhai]

Got it. Thanks for the so detailed explaination. It is clear now.
will try to do it tomorrow.