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

fix config links and apiVersion of example

Open jonmoter opened this issue 3 years ago • 2 comments

What does this PR do?

#435 renamed docs/configuration.md to docs.configuration.v1alpha1.md, but that broke links to that page. This fixes the links.

I also noticed that the example manifest in configuration.v2alpha1.md still referred to v1alpha1, which I assume is a copy-paste typo.

Motivation

I clicked on the "Configuration" link in the README and it took me to a 404 page.

Describe your test plan

n/a, doc change only

jonmoter avatar Aug 05 '22 19:08 jonmoter

Another pair of fixes to the configuration docs:

  1. In v2alpha1, the credentials parameters now exist under global, but the example didn't show that.
  2. In both example config pages, the text says it's setting agent.image.name, but that's not set in the example manifest right below it. Changed that to set the clusterName.

jonmoter avatar Aug 05 '22 20:08 jonmoter

Codecov Report

Merging #590 (aa0a0be) into main (d295739) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #590   +/-   ##
=======================================
  Coverage   58.51%   58.51%           
=======================================
  Files           3        3           
  Lines         135      135           
=======================================
  Hits           79       79           
  Misses         43       43           
  Partials       13       13           
Flag Coverage Δ
unittests 58.51% <ø> (ø)

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


Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update d295739...aa0a0be. Read the comment docs.

codecov-commenter avatar Aug 05 '22 21:08 codecov-commenter

Okay, I've updated the change so I'm no longer linking to v2alpha1 off the main README.md

jonmoter avatar Aug 17 '22 18:08 jonmoter