Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #10

Merged
merged 14 commits into from
Sep 11, 2024
Merged

Improve documentation #10

merged 14 commits into from
Sep 11, 2024

Conversation

blaubaer
Copy link
Member

No description provided.

@blaubaer blaubaer added the documentation Improvements or additions to documentation label Aug 27, 2024
@blaubaer blaubaer self-assigned this Aug 27, 2024
@blaubaer blaubaer added this to the v0.1.2 milestone Aug 27, 2024
@blaubaer blaubaer added the accepted This issue was accepted by the code owners. label Aug 27, 2024
Copy link

Deploying bifroest-engity-org with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9e6b07a
Status: ✅  Deploy successful!
Preview URL: https://b4316757.bifroest-engity-org.pages.dev
Branch Preview URL: https://improve-doc.bifroest-engity-org.pages.dev

View logs

@blaubaer blaubaer marked this pull request as ready for review September 3, 2024 18:05
blaubaer and others added 4 commits September 4, 2024 18:46
Bumps
[github.com/Masterminds/sprig/v3](https://github.com/Masterminds/sprig)
from 3.2.3 to 3.3.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/Masterminds/sprig/releases">github.com/Masterminds/sprig/v3's
releases</a>.</em></p>
<blockquote>
<h2>v3.3.0</h2>
<h2>What's Changed</h2>
<ul>
<li>Updating the Go versions used in testing by <a
href="https://github.com/mattfarina"><code>@​mattfarina</code></a> in <a
href="https://redirect.github.com/Masterminds/sprig/pull/405">Masterminds/sprig#405</a></li>
<li>Change intial to initial. by <a
href="https://github.com/chrishalbert"><code>@​chrishalbert</code></a>
in <a
href="https://redirect.github.com/Masterminds/sprig/pull/391">Masterminds/sprig#391</a></li>
<li>Updating dependencies by <a
href="https://github.com/mattfarina"><code>@​mattfarina</code></a> in <a
href="https://redirect.github.com/Masterminds/sprig/pull/404">Masterminds/sprig#404</a></li>
<li>correct value by <a
href="https://github.com/jheyduk"><code>@​jheyduk</code></a> in <a
href="https://redirect.github.com/Masterminds/sprig/pull/376">Masterminds/sprig#376</a></li>
<li>Updating location of mergo by <a
href="https://github.com/mattfarina"><code>@​mattfarina</code></a> in <a
href="https://redirect.github.com/Masterminds/sprig/pull/406">Masterminds/sprig#406</a></li>
<li>feature: added sha512sum function by <a
href="https://github.com/itzik-elayev"><code>@​itzik-elayev</code></a>
in <a
href="https://redirect.github.com/Masterminds/sprig/pull/400">Masterminds/sprig#400</a></li>
<li>docs: Add missing link to url functions by <a
href="https://github.com/carlpett"><code>@​carlpett</code></a> in <a
href="https://redirect.github.com/Masterminds/sprig/pull/375">Masterminds/sprig#375</a></li>
<li>Update doc.go by <a
href="https://github.com/chey"><code>@​chey</code></a> in <a
href="https://redirect.github.com/Masterminds/sprig/pull/369">Masterminds/sprig#369</a></li>
<li>Update mathf.md by <a
href="https://github.com/zzhu41"><code>@​zzhu41</code></a> in <a
href="https://redirect.github.com/Masterminds/sprig/pull/290">Masterminds/sprig#290</a></li>
<li>Removing duplicate documentation by <a
href="https://github.com/mattfarina"><code>@​mattfarina</code></a> in <a
href="https://redirect.github.com/Masterminds/sprig/pull/407">Masterminds/sprig#407</a></li>
<li>Updating the changelog for the 3.3.0 release by <a
href="https://github.com/mattfarina"><code>@​mattfarina</code></a> in <a
href="https://redirect.github.com/Masterminds/sprig/pull/408">Masterminds/sprig#408</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a
href="https://github.com/chrishalbert"><code>@​chrishalbert</code></a>
made their first contribution in <a
href="https://redirect.github.com/Masterminds/sprig/pull/391">Masterminds/sprig#391</a></li>
<li><a href="https://github.com/jheyduk"><code>@​jheyduk</code></a> made
their first contribution in <a
href="https://redirect.github.com/Masterminds/sprig/pull/376">Masterminds/sprig#376</a></li>
<li><a
href="https://github.com/itzik-elayev"><code>@​itzik-elayev</code></a>
made their first contribution in <a
href="https://redirect.github.com/Masterminds/sprig/pull/400">Masterminds/sprig#400</a></li>
<li><a href="https://github.com/carlpett"><code>@​carlpett</code></a>
made their first contribution in <a
href="https://redirect.github.com/Masterminds/sprig/pull/375">Masterminds/sprig#375</a></li>
<li><a href="https://github.com/chey"><code>@​chey</code></a> made their
first contribution in <a
href="https://redirect.github.com/Masterminds/sprig/pull/369">Masterminds/sprig#369</a></li>
<li><a href="https://github.com/zzhu41"><code>@​zzhu41</code></a> made
their first contribution in <a
href="https://redirect.github.com/Masterminds/sprig/pull/290">Masterminds/sprig#290</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/Masterminds/sprig/compare/v3.2.3...v3.3.0">https://github.com/Masterminds/sprig/compare/v3.2.3...v3.3.0</a></p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/Masterminds/sprig/blob/master/CHANGELOG.md">github.com/Masterminds/sprig/v3's
changelog</a>.</em></p>
<blockquote>
<h2>Release 3.3.0 (2024-08-29)</h2>
<h3>Added</h3>
<ul>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/400">#400</a>:
added sha512sum function (thanks <a
href="https://github.com/itzik-elayev"><code>@​itzik-elayev</code></a>)</li>
</ul>
<h3>Changed</h3>
<ul>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/407">#407</a>:
Removed duplicate documentation (functions were documentated in 2
places)</li>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/290">#290</a>:
Corrected copy/paster oops in math documentation (thanks <a
href="https://github.com/zzhu41"><code>@​zzhu41</code></a>)</li>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/369">#369</a>:
Corrected template reference in docs (thanks <a
href="https://github.com/chey"><code>@​chey</code></a>)</li>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/375">#375</a>:
Added link to URL documenation (thanks <a
href="https://github.com/carlpett"><code>@​carlpett</code></a>)</li>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/406">#406</a>:
Updated the mergo dependency which had a breaking change (which was
accounted for)</li>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/376">#376</a>:
Fixed documentation error (thanks <a
href="https://github.com/jheyduk"><code>@​jheyduk</code></a>)</li>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/404">#404</a>:
Updated dependency tree</li>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/391">#391</a>:
Fixed misspelling (thanks <a
href="https://github.com/chrishalbert"><code>@​chrishalbert</code></a>)</li>
<li><a
href="https://redirect.github.com/Masterminds/sprig/issues/405">#405</a>:
Updated Go versions used in testing</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/Masterminds/sprig/commit/e708470d529a10ac1a3f02ab6fdd339b65958372"><code>e708470</code></a>
Merge pull request <a
href="https://redirect.github.com/Masterminds/sprig/issues/408">#408</a>
from mattfarina/update-changelog-3.3</li>
<li><a
href="https://github.com/Masterminds/sprig/commit/8fc4354ab4cdcdb0e18fc6626812286476209e20"><code>8fc4354</code></a>
Updating the changelog for the 3.3.0 release</li>
<li><a
href="https://github.com/Masterminds/sprig/commit/cb81a327e35eb6ff7f1856dacf4310efb5d7f2d7"><code>cb81a32</code></a>
Merge pull request <a
href="https://redirect.github.com/Masterminds/sprig/issues/407">#407</a>
from mattfarina/remove-dup-math-functions</li>
<li><a
href="https://github.com/Masterminds/sprig/commit/26376936dd279f4e1389cd772ca9132d123c9ed5"><code>2637693</code></a>
Removing duplicate documentation</li>
<li><a
href="https://github.com/Masterminds/sprig/commit/06b9a87558bb8fc85b29a84603a9116f381283af"><code>06b9a87</code></a>
Merge pull request <a
href="https://redirect.github.com/Masterminds/sprig/issues/290">#290</a>
from zzhu41/patch-1</li>
<li><a
href="https://github.com/Masterminds/sprig/commit/e663ec6019887546abdc1b4505bc382ced00cc61"><code>e663ec6</code></a>
Merge pull request <a
href="https://redirect.github.com/Masterminds/sprig/issues/369">#369</a>
from chey/patch-1</li>
<li><a
href="https://github.com/Masterminds/sprig/commit/bb2f73f85f05cc0306814d56c91941b2cc80491e"><code>bb2f73f</code></a>
Merge pull request <a
href="https://redirect.github.com/Masterminds/sprig/issues/375">#375</a>
from carlpett/patch-1</li>
<li><a
href="https://github.com/Masterminds/sprig/commit/f07659ea6531546e2e3c1648b63b3e7d0085f195"><code>f07659e</code></a>
Merge pull request <a
href="https://redirect.github.com/Masterminds/sprig/issues/400">#400</a>
from itzik-elayev/master</li>
<li><a
href="https://github.com/Masterminds/sprig/commit/98b35c11f040f8247922ca5680d7c338d50fd8da"><code>98b35c1</code></a>
Add closing bracket</li>
<li><a
href="https://github.com/Masterminds/sprig/commit/7a88928df533ea5e7c0d3cdae521358e636a3bf8"><code>7a88928</code></a>
Merge pull request <a
href="https://redirect.github.com/Masterminds/sprig/issues/406">#406</a>
from mattfarina/update-mergo</li>
<li>Additional commits viewable in <a
href="https://github.com/Masterminds/sprig/compare/v3.2.3...v3.3.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=github.com/Masterminds/sprig/v3&package-manager=go_modules&previous-version=3.2.3&new-version=3.3.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Gregor Noczinski <[email protected]>
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/reference/authorization/index.md Outdated Show resolved Hide resolved
docs/reference/templating/index.md Outdated Show resolved Hide resolved
docs/reference/templating/index.md Outdated Show resolved Hide resolved
docs/reference/connection/index.md Outdated Show resolved Hide resolved
docs/reference/connection/index.md Outdated Show resolved Hide resolved
docs/reference/connection/ssh.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/community/contributing.md Outdated Show resolved Hide resolved
docs/community/contributing.md Outdated Show resolved Hide resolved
docs/community/contributing.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
docs/usecases.md Outdated Show resolved Hide resolved
@blaubaer blaubaer merged commit 4cacbc1 into main Sep 11, 2024
9 checks passed
@blaubaer blaubaer deleted the improve-doc branch September 11, 2024 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted This issue was accepted by the code owners. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants