Description
Is there an existing proposal for this?
- I have searched the existing proposals
Is your feature request related to a problem?
Currently, we have two supported ways of building BlazingMQ:
- Building using our build scripts in
bin/for Ubuntu and Darwin. These build scripts are very useful for managing some of the complexity of building our two biggest dependencies,bdeandntf-core, but for a user to build with them, they need to read through the build script first to ensure that they have the proper package manager dependencies installed. They also need to read through the script to see what environment variables they can pass to control the building and installation of BlazingMQ and its dependencies. - Building with our example Dockerfile, either in a single-node or cluster scenario. This also serves as a very useful example for deploying BlazingMQ, as it contains example configuration files.
Additionally, we may soon have vcpkg support coming. This will not make the above obsolete for all users, especially if they want to do development on the broker itself.
Other open source projects (for example, OBS, Kubernetes, or GNU/Emacs) maintain documentation that walks users through all supported ways of building the software. This is useful in addition to the above build scripts; Kubernetes, for instance, uses its build documentation to describe how to use the build scirpts.
Describe the solution you'd like
To lower the cost to entry for people wishing to contribute to the project, it would be beneficial to include better documentation on how to build and install a BlazingMQ broker and client library. While this is especially important with regard to the broker, it still is beneficial for users who would prefer building themselves, perhaps if they are packaging BlazingMQ or are in an environment where they aren't able to use our potential vcpkg support.
Alternatives you considered
No response