Skip to content

Comments

docs: fix broken link and adjust markdown annotation#2331

Merged
briantwatson merged 1 commit intomainfrom
docs/broken-link
Jan 30, 2026
Merged

docs: fix broken link and adjust markdown annotation#2331
briantwatson merged 1 commit intomainfrom
docs/broken-link

Conversation

@briantwatson
Copy link
Contributor

Description

  • Fixing broken link
  • Adjusted annotation from Note to Important to align with block below that is worded with similar intent

Related Issue

n/a

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Steps to Validate

n/a

Checklist before merging

Copilot AI review requested due to automatic review settings January 30, 2026 16:37
@briantwatson briantwatson requested a review from a team as a code owner January 30, 2026 16:37
@briantwatson briantwatson self-assigned this Jan 30, 2026
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lula Compliance Overview

Please review the changes to ensure they meet compliance standards.

Reviewed Changes

Lula reviewed 1 files changed that affect compliance.


File Lines Changed
README.md 124–128

UUID: 7d855a1f-5735-498a-95ad-f0d2fa572cb1
sha256: 2409774bd4229e3b08ba9b8e8b397b16585aad97426274966ae3da8037f9fbf6


Tip: Customize your compliance reviews with Lula.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes documentation issues in the README by correcting a broken link and improving the clarity of warnings about production usage.

Changes:

  • Fixed broken link to UDS Operator documentation by replacing local file reference with online documentation URL
  • Changed markdown annotation from NOTE to IMPORTANT for dev/test environment warning to better align with similar warnings
  • Improved markdown formatting with appropriate whitespace around code blocks and diagrams

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mjnagel mjnagel dismissed github-actions[bot]’s stale review January 30, 2026 16:58

no compliance changes, just some spacing

@briantwatson briantwatson merged commit 5d542a3 into main Jan 30, 2026
20 checks passed
@briantwatson briantwatson deleted the docs/broken-link branch January 30, 2026 17:01
chance-coleman added a commit that referenced this pull request Feb 10, 2026
🤖 I have created a release *beep* *boop*
---


##
[0.61.0](v0.60.0...v0.61.0)
(2026-02-10)


### Features

* add blackbox exporter to uds-core as optional component
([#2314](#2314))
([2f08ee5](2f08ee5))
* automount uds trust bundle to all applications
([#2337](#2337))
([ce66203](ce66203))
* cluster-less crd pipeline
([#2316](#2316))
([5128ffb](5128ffb))
* improve Keycloak availability
([#2334](#2334))
([a306465](a306465))


### Bug Fixes

* cleanup zarf --no-progress deprecation
([#2352](#2352))
([78d3b15](78d3b15))
* ensure ambient mode is the default in all operator code
([#2326](#2326))
([bda5384](bda5384))
* multiarch script output
([#2338](#2338))
([457d9b3](457d9b3))
* validate authservice callback uri + redirect uri
([#2349](#2349))
([0ae9121](0ae9121))


### Miscellaneous

* bump eks/aks k8s to 1.34
([#2339](#2339))
([4145337](4145337))
* crd versioning adr
([#2308](#2308))
([f1e5a86](f1e5a86))
* **deps:** bump @isaacs/brace-expansion from 5.0.0 to 5.0.1
([#2336](#2336))
([5db96c7](5db96c7))
* **deps:** bump lodash from 4.17.21 to 4.17.23
([#2319](#2319))
([ad29405](ad29405))
* **deps:** update grafana
([#2257](#2257))
([74ad882](74ad882))
* **deps:** update keycloak to v26.5.2
([#2297](#2297))
([e393a3d](e393a3d))
* **deps:** update loki
([#2265](#2265))
([e12859b](e12859b))
* **deps:** update metrics-server to v0.8.1
([#2324](#2324))
([a48c45a](a48c45a))
* **deps:** update pepr to v1.0.8
([#2320](#2320))
([b4b1b48](b4b1b48))
* **deps:** update vector
([#2315](#2315))
([872f083](872f083))
* remove deprecated devDep for root-ca script
([#2342](#2342))
([616fbdb](616fbdb))
* update uds package icon to new doug logo
([#2353](#2353))
([77150aa](77150aa))


### Documentation

* add clarity on label placement for reload
([#2330](#2330))
([1a2515f](1a2515f))
* fix broken link and adjust markdown annotation
([#2331](#2331))
([5d542a3](5d542a3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Chance Coleman <139784371+chance-coleman@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants