theBeamBook
theBeamBook copied to clipboard
happi
Suggestion: Make explicit the version of Erlang in the book
As stated here, it may be helpful to explicitly state somewhere in the book which version it targets. Then readers can guess about the contents of the book even after the implementation is changed later. Since sometimes there are major changes that affect the contents of this book.
Yes, I have been thinking about this. One problem is that right now there are old pieces of text written when Erlang was on version 14 and and 15 and newer parts that cover version 18 and 19. Perhaps we would need to tag each chapter with which Erlang version it is updated to?
The goal right now is to cover Erlang 19 but we can not really state in the preface or introduction that the book covers 19 since some chapters have not been revised to that version.
I am all for making this information clear in some way so any suggestion on how to do it is welcome.
I think a [NOTE] at the start of each chapter describing which version it was written for would be great.
OTP 21 changes how messages are added to other processes, but I'm not 💯 if the diagrams need to change.
Agreed with @garazdawi 's comment above, I think just adding OTP version to [NOTE] would work. If there is more to say, we can always add descriptions to it.
As a side note, I tried to add some tags icon with right-aligned as below, but it did not work for pdf:
It built, but looks as below:
- I see it's using dblatex, but asciidoctor-pdf can not be used?
- Also, shaape does not look being maintained anymore (https://github.com/christiangoltz/shaape/issues/20), the last commit was 2014. Does it make sense to look for an alternative ?
Yes it might be a good time to update the build process. My plan is to get to finish the missing chapters in the near future and I will work more actively on the book now.
If you have some suggestions please let me know.
The addition of missing chapters would be great. Does it help in any way to try to improve the formatting or layout at the moment, or better to wait for now?
As part of https://github.com/happi/theBeamBook/pull/135, Admonition icon works in pdf as below:
On HTML, it looks as below:
