search

operator-framework / olm-docs

Hugo doc site for https://github.com/operator-framework/operator-lifecycle-manager
10 stars 82 forks source link

Add diagram doc for upgrade graphs #97

Closed camilamacedo86 closed 3 years ago

camilamacedo86 commented 3 years ago

Description The goal of this PR is to document a definition that should be used in the upgrade graphs.

Motivation Define a standard to communicate with others about the upgrade graphs. We can probably in the future link this new doc/section such as "to understand the legend in the diagrams in this doc, see the section Standards and definitions in the Upgrade Graphs Diagrams doc". Also, it is helpful for we understand the user's scenarios when they need our help. So, this doc will help then know how thy a use the editor online to describe their scenarios as well.

See its preview here: https://deploy-preview-97--operator-lifecycle-manager.netlify.app/docs/contribution-guidelines/upgrade-graphs/

camilamacedo86 commented 3 years ago

Hi @bentito and @anik120,

I tried to address your suggestions and to do a few changes improvements as well. Really thank you for your time and review. Also, please feel free to do another round and to raise any suggestion that you think that is required for we get this doc merged.

bentito commented 3 years ago

/lgtm

anik120 commented 3 years ago

/lgtm