fluent-operator icon indicating copy to clipboard operation
fluent-operator copied to clipboard

Docs website

Open jynolen opened this issue 2 years ago • 4 comments

Is your feature request related to a problem? Please describe.

Would it be possible to embed the docs in a nice website to make navigation over ressources more confortable ? Fluentd & fluent-bit have their own why not the operator.

Describe the solution you'd like

A gitbook site for the operator (or other docgen)

Additional context

No response

jynolen avatar Apr 01 '23 11:04 jynolen

@jynolen we have the idea of having a website for fluent-operator, we just short of hands. If you're interested in helping maintaining and creating the website, it'll be great. We can start by creating a hugo project repo in fluent org(need @patrick-stephens and @agup006 's help), and deploy it on netlify

benjaminhuo avatar Apr 01 '23 11:04 benjaminhuo

I will be glad to help with the small amount of time I got :-D

jynolen avatar Apr 01 '23 12:04 jynolen

I will be glad to help with the small amount of time I got :-D

Great! @patrick-stephens , are you using gitbook to set up fluentbit and fluentd docs websites? I think we need a new repo called fluent-operator-docs! And then @jynolen @wanjunlei @wenchajun we all can help on fluent operator docs

benjaminhuo avatar Apr 01 '23 15:04 benjaminhuo

I'm afraid I have little knowledge of the overall set up for docs but it is all handled here for Fluent Bit: https://github.com/fluent/fluent-bit-docs

We really need a better way of tracking these requests for new repos, at the moment it is all a little ad-hoc. I'll defer to @agup006 just to confirm he's ok with it but I have no issue with creating it. Please document all set up including users you want access and at what level (e.g. admin vs maintain vs write). Personally I would recommend creating a team and managing access that way, then just add/remove people to the team.

patrick-stephens avatar Apr 03 '23 08:04 patrick-stephens