Google Git
Sign in
apache / bookkeeper / b7814804fc081c6ca72094c5659739f074cf8be9
commitb7814804fc081c6ca72094c5659739f074cf8be9[log] [tgz]
authorAnup Ghatage <ghatageanup@gmail.com>Tue Oct 06 01:53:15 2020 -0700
committerGitHub <noreply@github.com>Tue Oct 06 10:53:15 2020 +0200
treec3da7d77695cf442f981148d150bff47bff22089
parent67a02db73d62188fc8a143bd9a37038ae770e90a [diff]
New Bookkeeper docusaurus based website

The Apache Bookkeeper website is a custom built website. While that is cool, its also additional maintenance for the PMC/Committers.
sijie suggested that we can follow the same path as the Pulsar project and have a docusaurus based website which  uses markdown heavily and is easier to manage and update.

This is a a WIP and this draft PR is to keep the PMC/Committers updated about the progress on the website.

The goal of this PR is to be able to create a basic skeleton of the website with the following pages (and their sub pages) fully fleshed out:
* Project
* Community
* Blog
* Landing page

So with this, the only thing that remains is the rest of the versioned documentation.
That work can be done in smaller modules as follow ups.
This PR will be opened for review and then can be merged once the above mentioned pages are declared to be complete.

cc eolivelli 

Reviewers: Enrico Olivelli <eolivelli@gmail.com>, Sijie Guo <sijie@apache.org>

This closes #2426 from Ghatage/docusaurus-website-poc
36 files changed
tree: c3da7d77695cf442f981148d150bff47bff22089
  1. .github/
  2. .test-infra/
  3. bin/
  4. bookkeeper-benchmark/
  5. bookkeeper-common/
  6. bookkeeper-common-allocator/
  7. bookkeeper-dist/
  8. bookkeeper-http/
  9. bookkeeper-proto/
  10. bookkeeper-server/
  11. bookkeeper-stats/
  12. bookkeeper-stats-providers/
  13. buildtools/
  14. circe-checksum/
  15. conf/
  16. cpu-affinity/
  17. deploy/
  18. dev/
  19. docker/
  20. metadata-drivers/
  21. microbenchmarks/
  22. shaded/
  23. site/
  24. site2/
  25. stats/
  26. stream/
  27. tests/
  28. tools/
  29. .gitignore
  30. LICENSE
  31. NOTICE
  32. pom.xml
  33. README.md
README.md

Build Status Build Status Coverage Status Maven Central

Apache BookKeeper

Apache BookKeeper is a scalable, fault tolerant and low latency storage service optimized for append-only workloads.

It is suitable for being used in following scenarios:

  • WAL (Write-Ahead-Logging), e.g. HDFS NameNode.
  • Message Store, e.g. Apache Pulsar.
  • Offset/Cursor Store, e.g. Apache Pulsar.
  • Object/Blob Store, e.g. storing state machine snapshots.

Get Started

  • Concepts: Start with the basic concepts of Apache BookKeeper. This will help you to fully understand the other parts of the documentation.
  • Getting Started to setup BookKeeper to write logs.

Documentation

Developers

You can also read Turning Ledgers into Logs to learn how to turn ledgers into continuous log streams. If you are looking for a high level log stream API, you can checkout DistributedLog.

Administrators

Contributors

Get In Touch

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, help us out by opening a Github issue or opening an Apache jira.

Need Help?

Subscribe or mail the user@bookkeeper.apache.org list - Ask questions, find answers, and also help other users.

Subscribe or mail the dev@bookkeeper.apache.org list - Join development discussions, propose new ideas and connect with contributors.

Join us on Slack - This is the most immediate way to connect with Apache BookKeeper committers and contributors.

Contributing

We feel that a welcoming open community is important and welcome contributions.

Contributing Code

  1. See Developer Setup to get your local environment setup.

  2. Take a look at our open issues: JIRA Issues Github Issues.

  3. Review our coding style and follow our pull requests to learn about our conventions.

  4. Make your changes according to our contribution guide.

Improving Website and Documentation

  1. See Building the website and documentation on how to build the website and documentation.