search

datactive / bigbang

Scientific analysis of collaborative communities
http://datactive.github.io/bigbang/
MIT License
149 stars 52 forks source link

autodocs #412

Closed sbenthall closed 2 years ago

sbenthall commented 3 years ago

We've made it this far without automated documentation. But we should make a documentation directory and publish the docs to readthedocs.

https://readthedocs.org/

npdoty commented 3 years ago

I think this is a duplicate of #340.

sbenthall commented 3 years ago

A hangup: another project is currently using: https://bigbang.readthedocs.io/en/latest/

I've asked that project if they would be willing to give up the URL, since they don't seem to be using it: https://github.com/lennonalvesdias/BigBang/issues/5

If that doesn't work we may need to come up with a different URL, like bigbang-project.

npdoty commented 2 years ago

Thanks for doing that outreach. Maybe big-bang is a (temporary) option too?

Or ReadTheDocs also supports a subdomain of a custom domain; e.g. docs.bigbang.data-activism.net. @nllz , do you think datactive would be supportive of that? It might be nice to move the project webpage to bigbang.data-activism.net instead of a Github subdomain as well.

nllz commented 2 years ago

That would definitely be possible, but datactive as a project has ended. While we can still is datactive, nor IN-SIGHT.it, which is the follow-up project, we can also choose to register our own domain?

I have no strong feelings either way and am happy to make it happen.

sbenthall commented 2 years ago

There are a number of intersecting questions about the project's identity involved here.

If datactive is no longer an active project, then we should consider moving the bigbang repository to a different GitHub organization.

nllz commented 2 years ago

I think the project is adult enought to be its own organization I'd say.

But as said, happy to make it part of https://github.com/in-sight-it/ (the project in which @pgroth and I work). That project will run for tour more years.

sbenthall commented 2 years ago

For RTD, I think I'd like to go with bigbang-py. Opening the possibility of alternative implementations in other languages, like Julia.

I think we should set up a separate organization that corresponds to whatever consortium of internet researchers we would like to recognized as. This organization would ultimately become the foundation that manages the data licensing.

in-sigh-it could maintain a fork?

sbenthall commented 2 years ago

This issue is done with PR #491