Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add developer documentation #4

Merged
merged 28 commits into from
Dec 4, 2022
Merged

Conversation

jwuensche
Copy link
Contributor

@jwuensche jwuensche commented Jul 19, 2022

This PR contains some initial work to provide documentation to developers wanting to work on haura.

It aims to contain both an overview of the conceptual level of the storage design and internal implementation related to these.
Also, new features can be drafted here and reasoning added as to why some implementations have been chosen over another (picture RFC like).

What has been done?

  • Navigation Page
  • betree
    • betree crate concept
      • Database, Dataset, Objectstore
      • B-epsilon tree
      • Data Management
      • Storage Pool (not fully complete - Segments)
    • betree modules
    • betree known bugs
  • bectl
    • purpose
    • usage
  • julea-sys
    • generation
  • julea-betree
    • build
    • validation

@jwuensche
Copy link
Contributor Author

I've done some changes to the structure of the documentation. First, it now uses mdbook to document the building and getting started of the stack in a more friendly way. Second, a workflow has been added which (when present on the main branch) automatically builds and deploys the most recent version of the docs as an html book, which is then reachable under https://julea-io.github.io/haura.

@jwuensche jwuensche marked this pull request as ready for review November 29, 2022 09:09
Copy link
Member

@michaelkuhn michaelkuhn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found a few small typos etc. that we should fix before merging.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/src/bectl.md Outdated Show resolved Hide resolved
docs/src/bectl/build.md Outdated Show resolved Hide resolved
docs/src/bectl/build.md Outdated Show resolved Hide resolved
docs/src/build.md Outdated Show resolved Hide resolved
docs/src/build.md Outdated Show resolved Hide resolved
docs/src/build.md Outdated Show resolved Hide resolved
docs/src/julea-betree/usage.md Outdated Show resolved Hide resolved
docs/src/julea-sys.md Outdated Show resolved Hide resolved
Co-authored-by: Michael Kuhn
Copy link
Member

@michaelkuhn michaelkuhn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@michaelkuhn michaelkuhn merged commit 88c12f6 into parcio:main Dec 4, 2022
@jwuensche jwuensche deleted the docs/init branch September 20, 2023 06:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants