reva icon indicating copy to clipboard operation
reva copied to clipboard

Missing docs link for ocmproviderauthorizer

Open michielbdejong opened this issue 3 years ago • 2 comments

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:

  • [ ] https://reva.link/docs/config/grpc/services/ocmproviderauthorizer/
  • [ ] https://reva.link/docs/config/grpc/services/groupprovider/
  • [ ] https://reva.link/docs/config/grpc/services/ocmcore/
  • [ ] https://reva.link/docs/config/grpc/services/ocmshareprovider/
  • [ ] https://reva.link/docs/config/grpc/services/ocminvitemanager/
  • [ ] https://reva.link/docs/config/grpc/services/ocmd/
  • [ ] https://reva.link/docs/config/grpc/services/ocdav/

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

  • [ ] https://reva.link/docs/config/http/middlewares/cors/
  • [ ] https://reva.link/docs/config/grpc/services/gateway/
  • [ ] https://reva.link/docs/config/grpc/services/authregistry/
  • [ ] https://reva.link/docs/config/grpc/services/authprovider/
  • [ ] https://reva.link/docs/config/grpc/services/userprovider/

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 avatar Dec 08 '22 13:12 michielbdejong

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!

michielbdejong avatar Dec 08 '22 13:12 michielbdejong

@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.

labkode avatar Dec 19 '22 11:12 labkode