search

cs3org / reva

WebDAV/gRPC/HTTP high performance server to link high level clients to storage backends
https://reva.link
Apache License 2.0
167 stars 113 forks source link

Missing docs link for ocmproviderauthorizer #3532

Open michielbdejong opened 1 year ago

michielbdejong commented 1 year ago

https://reva.link/docs/config/grpc/services/ocmproviderauthorizer/ is linked from https://developer.sciencemesh.io/docs/technical-documentation/iop/configuration/basic/#ocm-provider-authorizer-docs-httpsrevalinkdocsconfiggrpcservicesocmproviderauthorizer but it is a 404.

In fact it's not the only one, all of these are linked from the sciencemesh docs, but are 404s in the reva config docs:

And the following ones are not 404s but just say 'TODO':

Let's at least dive into the code and list what the valid drivers are for each service, and for each driver, values reva will try to read from the config.

michielbdejong commented 1 year ago

I see for instance https://github.com/cs3org/reva/blob/af8fe04/pkg/ocm/provider/authorizer/mentix/mentix.go#L81 has 'docs' in a comment; that suggests that we could maybe even auto-generate these docs from code comments?

That would be best of course!

labkode commented 1 year ago

@michielbdejong yes the doc gets automatically generated from the code, but the code is missing the comments, I'll address some of these with my team on our return from holidays. In the mean time, anyone can start adding comments to the configuration of these services and the makefile has the code to generate the docs.