Create code overview page in 2.0 manual#176
Conversation
|
I like this idea! We could also update this page, simplify it a bit: https://accumulo.apache.org/contributors-guide/ |
* Describes Accumulo design and links to relevant sections of the code.
mikewalch
force-pushed
the
code-overview
branch
from
8e698f7 to
d0fec35
Compare
ctubbsii
left a comment
ctubbsii
left a comment
There was a problem hiding this comment.
I like the idea of this page... but I'm worried about the increased amount of code within our website generation. The website docs should be simple, static, and easy to maintain. The more code we add in place of static website content, the more the bar is raised, making it more difficult for others (especially non-programmers) to contribute to the documentation.
keith-turner
left a comment
keith-turner
left a comment
There was a problem hiding this comment.
Could add a section for FATE
| * responds to reads from clients and form a sorted merge view of all | ||
| key/value pairs from all files & memory | ||
| * perform recovery of a [Tablet] that was previously on a server that failed | ||
| and reapply any writes found in the write-ahead log to the tablet |
There was a problem hiding this comment.
Should add compactions to the list. Could also add caching and bulk import.
_docs-2/troubleshooting/code.md
Outdated
| * [detect and respond][update] to [TabletServer] failures | ||
| * assign and balance tablets to Tablet Servers using a [TabletBalancer] | ||
| * handle table creation, alteration and deletion requests from clients using the [TableManager] | ||
| * coordinate changes to write-ahead logs using the [WalStateManager]. |
There was a problem hiding this comment.
Could be more specific. It coordinates sorting of WALs and associates WALs to tablets that need them (tablets that were previously assigned to a dead tserver) before assigning.
It may raise the bar for contributing to the website, but I think its worthwhile if it results in a more productive experience for users. W/o the new automation I would not create many links that I now create because it would be too cumbersome. I think these links are beneficial to the user. |
|
@mikewalch any plans to complete this? If not, I will just close this for now since you were championing for it. We can always open another PR in the future if you pick it back up. |
4 participants
This should help users/developers learn code and troubleshoot issues on their own.
Making this a draft PR to get input before I finish the page.