Skip to content

Add upstream relationship documentation - #10223

Open
pbajjuri20 wants to merge 2 commits into
kiali:masterfrom
pbajjuri20:doc
Open

Add upstream relationship documentation#10223
pbajjuri20 wants to merge 2 commits into
kiali:masterfrom
pbajjuri20:doc

Conversation

@pbajjuri20

@pbajjuri20 pbajjuri20 commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add docs/upstream.md documenting Kiali's role as the community upstream project and its relationship to OSSM, related repositories, and release branches.
  • Covers repository layout, OSSM branch mapping, contribution workflow, release/sync process, OSSMC compatibility notes, CI, and PR targets.

Test plan

  • Documentation-only change; no code or CI impact
  • Review links and branch mapping table for accuracy
  • Confirm wording with maintainers (especially OSSM release alignment)

Made with Cursor

Document Kiali as the community upstream project, related repositories,
OSSM branch mapping, release workflow, and contribution guidelines in
the same style as openshift-service-mesh sail-operator and istio docs.

Co-authored-by: Cursor <cursoragent@cursor.com>
@pbajjuri20
pbajjuri20 marked this pull request as draft August 14, 2026 20:26
@pbajjuri20 pbajjuri20 self-assigned this Aug 17, 2026
@pbajjuri20
pbajjuri20 marked this pull request as ready for review August 18, 2026 19:14
@hhovsepy
hhovsepy requested a review from jshaughn August 19, 2026 10:16

@jshaughn jshaughn left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@pbajjuri20 I'm not sure what purpose this is serving. It seems like an OSSM-specific document inside of the docs folder. upstream.md is sort of vague. Can you better describe the benefit of this file?

Comment thread docs/upstream.md

| OSSM Release | Kiali Branch | Kiali Version |
|--------------|--------------|---------------|
| 3.4 | `v2.27` | 2.27 |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

meh - this is now yet another place we have to maintain compatibility matrix?

@pbajjuri20

Copy link
Copy Markdown
Contributor Author

@pbajjuri20 I'm not sure what purpose this is serving. It seems like an OSSM-specific document inside of the docs folder. upstream.md is sort of vague. Can you better describe the benefit of this file?

We’re doing this task to create a standard, explicit upstream/downstream workflow doc (docs/upstream.md) across OSSM repos so contributors (and AI agents) don’t have to infer the process from scattered tribal knowledge.

For this ticket, the goal is to document things like:

where changes should be proposed first (upstream vs related repos),
PR/backport and sync expectations,
coding/process alignment with upstream conventions.
That improves consistency, reduces wrong-target PRs, and makes agent-assisted contribution flows safer and more predictable across repositories (OSSM-13926).

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.

3 participants