You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--Please give us some feedback on your experience writing this PR ! https://app.datadoghq.com/forms/43db4c02-6837-400c-8083-692e141b1b88 !-->
### What does this PR do?
Adds a new skill, `/follow-pr` for.... well, following the status of a PR.
### Motivation
This is meant as a base for a future, more fully-featured `/polish-pr` skill
### Describe how you validated your changes
### Additional Notes
Co-authored-by: pierrelouis.veyrenc <pierrelouis.veyrenc@datadoghq.com> 25ec4bf
pipelines, so you rarely need to invoke them by hand — but they are useful when
4050
4050
adding or editing settings, debugging schema problems, or regenerating output
4051
4051
locally.</p>
4052
-
<h2id="how-the-commands-fit-together">How the commands fit together<aclass="headerlink" href="#how-the-commands-fit-together" title="Permanent link">¶</a></h2>
</span><spanid="__span-9-2"><aid="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>dda<spanclass="w"></span>inv<spanclass="w"></span>--<spanclass="w"></span>schema.locate<spanclass="w"></span><spanclass="s1">'*enabled'</span><spanclass="w"></span><spanclass="c1"># pattern: all paths ending in "enabled"</span>
<h2id="how-do-i-add-a-new-setting">How do I add a new setting?<aclass="headerlink" href="#how-do-i-add-a-new-setting" title="Permanent link">¶</a></h2>
3979
+
<h2id="how-do-i-add-a-new-setting">How do I add a new setting?</h2>
3980
3980
<ol>
3981
3981
<li>
3982
3982
<p><strong>Determine the node type.</strong> If the setting holds a value (string, number,
@@ -4019,12 +4019,12 @@ <h2 id="how-do-i-add-a-new-setting">How do I add a new setting?<a class="headerl
4019
4019
</span><spanid="__span-0-4"><aid="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><spanclass="w"></span><spanclass="nt">description</span><spanclass="p">:</span><spanclass="w"></span><spanclass="l l-Scalar l-Scalar-Plain">Enables the new feature.</span>
4020
4020
</span></code></pre></div>
4021
4021
<hr/>
4022
-
<h2id="how-do-i-deprecate-a-setting">How do I deprecate a setting?<aclass="headerlink" href="#how-do-i-deprecate-a-setting" title="Permanent link">¶</a></h2>
4022
+
<h2id="how-do-i-deprecate-a-setting">How do I deprecate a setting?</h2>
<h2id="how-do-i-make-a-setting-public">How do I make a setting public?<aclass="headerlink" href="#how-do-i-make-a-setting-public" title="Permanent link">¶</a></h2>
4027
+
<h2id="how-do-i-make-a-setting-public">How do I make a setting public?</h2>
4028
4028
<ol>
4029
4029
<li>
4030
4030
<p><strong>Write a <code>description</code></strong> that explains what the setting does, what the default means, and any caveats. Every public
@@ -4057,7 +4057,7 @@ <h2 id="how-do-i-make-a-setting-public">How do I make a setting public?<a class=
4057
4057
<p>The setting will appear in the configuration examples (ex: <code>datadog.yaml.example</code>) the next time the file is
4058
4058
regenerated.</p>
4059
4059
<hr/>
4060
-
<h2id="how-do-i-document-a-public-setting">How do I document a public setting?<aclass="headerlink" href="#how-do-i-document-a-public-setting" title="Permanent link">¶</a></h2>
4060
+
<h2id="how-do-i-document-a-public-setting">How do I document a public setting?</h2>
4061
4061
<ol>
4062
4062
<li><strong>Write a clear <code>description</code></strong> covering:</li>
4063
4063
<li>What the setting does.</li>
@@ -4082,13 +4082,13 @@ <h2 id="how-do-i-document-a-public-setting">How do I document a public setting?<
4082
4082
<li><strong>Set <code>visibility: public</code></strong> to include the setting in generated output.</li>
4083
4083
</ol>
4084
4084
<hr/>
4085
-
<h2id="how-do-i-generate-datadogyamlexample">How do I generate <code>datadog.yaml.example</code>?<aclass="headerlink" href="#how-do-i-generate-datadogyamlexample" title="Permanent link">¶</a></h2>
4085
+
<h2id="how-do-i-generate-datadogyamlexample">How do I generate <code>datadog.yaml.example</code>?</h2>
4086
4086
<p>The generation of <code>datadog.yaml.example</code> from the schema is wired into the
4087
4087
Agent's build pipeline and runs automatically. Developers do not normally need
4088
4088
to trigger it manually.</p>
4089
4089
<p>If you want to validate the generated example you can use <code>dda inv schema.template-all</code> command.</p>
4090
4090
<hr/>
4091
-
<h2id="what-is-the-difference-between-datadogyamlexample-and-system-probeyamlexample">What is the difference between <code>datadog.yaml.example</code> and <code>system-probe.yaml.example</code>?<aclass="headerlink" href="#what-is-the-difference-between-datadogyamlexample-and-system-probeyamlexample" title="Permanent link">¶</a></h2>
4091
+
<h2id="what-is-the-difference-between-datadogyamlexample-and-system-probeyamlexample">What is the difference between <code>datadog.yaml.example</code> and <code>system-probe.yaml.example</code>?</h2>
4092
4092
<p>Each configuration file has its own schema and its own generated example file:</p>
<li><strong>Path</strong> — a string of terms separated by dots (<code>"."</code>) that represents a series of nodes in the config tree.</li>
3902
3902
<li><strong>Setting</strong> — a configurable value that can be located using a path (example <code>apm_config.enabled</code>)</li>
3903
3903
<li><strong>Section</strong> — a groupping of settings under a common name (example <code>apm_config</code>)</li>
3904
3904
<li><strong>Object</strong> — a data type of key-value pairs. Also called a map (in Go) or dict (in Python), but called an object in JSON Schema since it comes from JavaScript.</li>
3905
3905
<li><strong>Default</strong> — the value that will be retrieved for a given setting if none is specified by the user's file-based configuration or environment variable (or other source).</li>
0 commit comments