chore: attempt to improve documentation

[Kavindu-Dodan]

This PR

Attempts to improve OFO documentation

Note - this should fix #483

[codecov]

Codecov Report

Merging #496 (4c4437a) into main (1ec3183) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #496   +/-   ##
=======================================
  Coverage   82.53%   82.53%           
=======================================
  Files          22       22           
  Lines        1386     1386           
=======================================
  Hits         1144     1144           
  Misses        205      205           
  Partials       37       37           

Flag	Coverage Δ
unit-tests	82.53% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[agardnerIT]

Thanks for these changes. They largely look great! A few comments though:

1. docs/getting_started.md and docs/quick_start.md should be combined. They serve largely the same purpose and as such, having both is confusing and redundant.
2. At the end of docs/installation.md we should link to docs/getting_started.md otherwise, after installation, I don't know what else to do.
3. At the end of docs/quick_start.md (or wherever that content ends up, we should mention that the OFO uses flagd as a flag provider and thus all the flagd documentation is also relevant. One specific callout is to point of the fact that ResolveString isn't the only option, but other options are available.

[Kavindu-Dodan]

Thanks for these changes. They largely look great! A few comments though:

1. docs/getting_started.md and docs/quick_start.md should be combined. They serve largely the same purpose and as such, having both is confusing and redundant.
2. At the end of docs/installation.md we should link to docs/getting_started.md otherwise, after installation, I don't know what else to do.
3. At the end of docs/quick_start.md (or wherever that content ends up, we should mention that the OFO uses flagd as a flag provider and thus all the flagd documentation is also relevant. One specific callout is to point of the fact that ResolveString isn't the only option, but other options are available.

thank you @agardnerIT for the feedback. I addressed all your points

1. Kept one quick start guide : this is now comprehensive and includes minimal installation instructions
2. Added the link to quick start guide : operator installation can be skipped but users can follow other steps to deploy a workload
3. Added the what's next section [1] linking to other resources

[1] - https://github.com/open-feature/open-feature-operator/pull/496/files#diff-61f4196322cfa9f52c5f548f13b7f781243b2cae898862a8688462d914ba7173R178-R182

[toddbaert]

This is an improvement, but I think there's a mistake here.

[Kavindu-Dodan]

This is an improvement, but I think there's a mistake here.

Thank you. I corrected them and also expanded Flag Source configuration section [1] with other flag sources and configuration options. Strangely, we never documented all the options we supported

[1] - https://github.com/open-feature/open-feature-operator/blob/b7a6b531ed9ab6edfe5ecf6038bfdc2ae570a811/docs/flag_source_configuration.md

[toddbaert]

LGTM, but I'd like to see this last small change: 1dbf3d0#r1258239251

[toddbaert]

@Kavindu-Dodan the last set of changes looks great! I think after it's merged we could put @thisthat 's changes in/around these changes as a sub-point.