Skip to content

Commit 53e2e9f

Browse files
PeterYurkovichPeterYurkovich
committed
chore: move docs and notes into wiki folder
1 parent 1985e73 commit 53e2e9f

File tree

5 files changed

+37
-67
lines changed

5 files changed

+37
-67
lines changed

‎README.md‎

Lines changed: 0 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -26,70 +26,3 @@ This repo uses the bash-language-server to lint and format files:
2626
- [lsp](https://github.com/bash-lsp/bash-language-server)
2727

2828
This repo uses [bun](https://bun.sh/) to bundle create and bundle a fork of the shikijs/cli which is able to have command results piped into it.
29-
30-
## Miro Mind Map
31-
[https://miro.com/app/board/uXjVIHGY4-A=/](https://miro.com/app/board/uXjVIHGY4-A=/)
32-
33-
## UI Plugins Life Cycle
34-
https://docs.google.com/spreadsheets/d/1iJP8hjod1J_Wqv_sfGglwVYquhsHLRlqjoyvrMBv0FY/edit?gid=0#gid=0
35-
36-
## OCP Life Cycle
37-
https://access.redhat.com/support/policy/updates/openshift
38-
39-
## Compatibility Matrix
40-
https://github.com/rhobs/observability-operator/blob/main/docs/user-guides/observability-ui-plugins.md
41-
42-
| __COO Version__ | __OCP Versions__ | __Dashboards__ | __Distributed Tracing__ | __Logging__ | __Troubleshooting Panel__ | __Monitoring__ |
43-
| --------------- | ------------------- | -------------- | ----------------------- | ----------- | ------------------------- | ---------------|
44-
| 0.2.0 | 4.11 | ✔ | ✘ | ✘ | ✘ | ✘ |
45-
| 0.3.0 - 0.4.0 | 4.11 - 4.15 | ✔ | ✔ | ✔ | ✘ | ✘ |
46-
| 0.3.0 - 0.4.0 | 4.16+ | ✔ | ✔ | ✔ | ✔ | ✘ |
47-
| 1.0.0+ | 4.11 - 4.14 | ✔ | ✔ | ✔ | ✘ | ✘ |
48-
| 1.0.0+ | 4.15 | ✔ | ✔ | ✔ | ✘ | ✔ |
49-
| 1.0.0+ | 4.16+ | ✔ | ✔ | ✔ | ✔ | ✔ |
50-
51-
52-
### Details on Monitoring Plugin Image Streams: Breaking Changes
53-
| __COO Version__ | __OCP Versions__ | __Breaking Change__ |
54-
| --------------- | ------------------- | ------------------- |
55-
|COO 1 | 4.12 - 4.14 | PF4 |
56-
|COO 1.1 | 4.15 - 4-18 | PF5 |
57-
|COO TBD | 4.19+ | PF6 |
58-
59-
Upcoming breaking change
60-
1. React Router may land in OCP 4.19 or 4.20
61-
62-
Minimize breaking changes to the same version to avoid multiple streams
63-
1. Konflux maintence of multiple versions/streams of the same component (e.g. Distributed-tracing-0.3, Distributed-tracing-0.4, Logging 6.0 Logging 6.1 all packaged in COO 1.2)
64-
2. Backporting becomes more complex. We cannot automatically backport; some manual adjustments are required to accommodate breaking changes.
65-
66-
### OpenShift Console Versions vs PatternFly Versions
67-
https://github.com/openshift/console/blob/main/frontend/packages/console-dynamic-plugin-sdk/README.md#openshift-console-versions-vs-patternfly-versions
68-
69-
Each Console version supports specific version(s) of [PatternFly](https://www.patternfly.org/) in terms
70-
of CSS styling. This table will help align compatible versions of PatternFly to versions of the OpenShift
71-
Console.
72-
73-
| Console Version | PatternFly Versions | Notes |
74-
| --------------- | ------------------- | ------------------------------------- |
75-
| 4.19.x | 6.x + 5.x | New dynamic plugins should use PF 6.x |
76-
| 4.15.x - 4.18.x | 5.x + 4.x | New dynamic plugins should use PF 5.x |
77-
| 4.12.x - 4.14.x | 4.x | |
78-
79-
80-
## ROSA Clusters
81-
Requires a STS role
82-
'ManagedOpenShift'
83-
84-
https://docs.openshift.com/rosa/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.html
85-
86-
## Konflux
87-
1. UI [https://console.redhat.com/application-pipeline/workspaces/jezhu/applications/perses-operator-staging/activity/pipelineruns](https://console.redhat.com/application-pipeline/workspaces/cluster-observabilit/applications)
88-
89-
90-
## Testing
91-
#### Monitoring Test Plan
92-
https://docs.google.com/document/d/1ZtGEFDOIsLDHnp8Gd0bq41RaRkm0_nrp37gj-mNo9BI/edit?usp=sharing
93-
94-
### COO Acceptance Criteria
95-
https://docs.google.com/document/d/1rBio1lFD3GzWqVP35ZLUdfVDNPwjDSxG08wy5Yo2tG8/edit?tab=t.0#heading=h.bupciudrwmna

‎wiki/Console-Extensions.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Console Extensions
2+
3+
### OpenShift Console Versions vs PatternFly Versions
4+
https://github.com/openshift/console/blob/main/frontend/packages/console-dynamic-plugin-sdk/README.md#openshift-console-versions-vs-patternfly-versions
5+
6+
Each Console version supports specific version(s) of [PatternFly](https://www.patternfly.org/) in terms
7+
of CSS styling. This table will help align compatible versions of PatternFly to versions of the OpenShift
8+
Console.
9+
10+
| Console Version | PatternFly Versions | Notes |
11+
| --------------- | ------------------- | ------------------------------------- |
12+
| 4.19.x | 6.x + 5.x | New dynamic plugins should use PF 6.x |
13+
| 4.15.x - 4.18.x | 5.x + 4.x | New dynamic plugins should use PF 5.x |
14+
| 4.12.x - 4.14.x | 4.x | |

‎wiki/External-Docs.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# External Docs
2+
3+
## Miro Mind Map
4+
[https://miro.com/app/board/uXjVIHGY4-A=/](https://miro.com/app/board/uXjVIHGY4-A=/)
5+
6+
## UI Plugins Life Cycle
7+
https://docs.google.com/spreadsheets/d/1iJP8hjod1J_Wqv_sfGglwVYquhsHLRlqjoyvrMBv0FY/edit?gid=0#gid=0
8+
9+
## OCP Life Cycle
10+
https://access.redhat.com/support/policy/updates/openshift
11+
12+
## Compatibility Matrix
13+
https://github.com/rhobs/observability-operator/blob/main/docs/user-guides/observability-ui-plugins.md
14+
15+
## Testing
16+
#### Monitoring Test Plan
17+
https://docs.google.com/document/d/1ZtGEFDOIsLDHnp8Gd0bq41RaRkm0_nrp37gj-mNo9BI/edit?usp=sharing
18+
19+
### COO Acceptance Criteria
20+
https://docs.google.com/document/d/1rBio1lFD3GzWqVP35ZLUdfVDNPwjDSxG08wy5Yo2tG8/edit?tab=t.0#heading=h.bupciudrwmna

brew-registry.md renamed to wiki/brew-registry.md

File renamed without changes.

‎wiki/konflux/konflux-ui.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Konflux UI
2+
3+
https://console.redhat.com/application-pipeline/workspaces/cluster-observabilit/applications

0 commit comments

Comments
 (0)