search

apache / kibble

Apache Kibble - a tool to collect, aggregate and visualize data about any software project
https://kibble.apache.org/
Apache License 2.0
35 stars 9 forks source link

Configuring and Priming the Kibble Instance #21

Open sufiyan-ahmed opened 9 months ago

sufiyan-ahmed commented 9 months ago

Description:

Documentation not in sync with repository **Reproduction steps:**
  1. I am attempting to set up Kibble on my MacOS, I have cloned the Kibble server repo : https://github.com/apache/kibble
  2. Following the official documentation (https://apache-kibble.readthedocs.io/en/latest/setup.html#configuring-and-priming-the-kibble-instance) it seems like things have changed but the documentation hasn't been updated.
  3. Eg:
    a> "Apache Kibble does not currently have any releases. You are however welcome to try out the development version.For the time being, we recommend that you use the master branch for testing Kibble. This applies to both scanners and the server." It asks to use the master branch but there in no master branch in https://github.com/apache/kibble b> Configuring and Priming the Kibble Instance: no requirements.txt file is present while the doc mentions it.

Actual result:

Unable to setup Kibble for testing purpose

OS:

MacOS

Logs:

Other:

sharanf commented 9 months ago

Hi @sufiyan-ahmed.

Thanks for taking a look at our project. And yes you are correct - the documentation is out of date (and I hope to start updating in the next few weeks). The code that is running the current demo at https://demo.kibble.apache.org/ comes from our old repos https://github.com/apache/kibble-1 and https://github.com/apache/kibble-scanners.

The documentation refers to Kibble-1 and the Kibble Scanners so if you clone the code from those repos then hopefully you will get further along in setting it up. Please try that and let me know how it goes.

Thanks Sharan

sufiyan-ahmed commented 9 months ago

Hello, Thanks for your reply @sharanf, I will proceed to try it out I read in a few places that Kibble 2.0 is at work, could you please provide any updates on that if available? I would like to be a part of any discussions or contributions concerning it.

Thanks Sufiyan