Skip to content

Commit 3706a49

Browse files
committed
Cleaning and simplification of initial refarch issue template
Signed-off-by: Ricardo Rocha <[email protected]>
1 parent 937b30c commit 3706a49

File tree

1 file changed

+21
-80
lines changed

1 file changed

+21
-80
lines changed
Lines changed: 21 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,59 @@
11
name: "Reference Architecture Submission"
22
description: "Submit a Reference Architecture for Community Review"
3-
title: "[Reference: ]"
4-
labels: ["reference-architecture"]
3+
title: "[Reference Architecture: ]"
4+
labels: ["area/reference-architecture"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
99
**Purpose of This Issue**
1010

11-
This is a submission to the reference architecture process.
12-
13-
Add more information here for submitters...
14-
11+
This is a submission for a proposal of a reference architecture, as [defined here](https://github.com/cncf/tab/blob/main/process/reference-architectures.md). It should not contain the full content but a summary to evaluate its relevance to the community.
1512
- type: input
1613
id: name
1714
attributes:
1815
label: Name
19-
description: What is the name of this architecture submission?
20-
placeholder: e.g., My Reference Architecture
16+
description: A name for this architecture submission. Suggestions include the name of the end user or domain as well as any specific area of interest (CI/CD, Edge, etc)
17+
placeholder: Edge Deployments at Organization XYZ
2118
validations:
2219
required: true
2320
- type: input
24-
id: affiliation
21+
id: organization
2522
attributes:
26-
label: Affiliation
23+
label: Organization
2724
description: Architectures must be submitted by at least one CNCF Member Company
28-
placeholder: List of Companies
29-
validations:
30-
required: true
31-
- type: textarea
32-
id: description
33-
attributes:
34-
label: Organizational Description
35-
description: Describe your Organization
36-
placeholder: A brief description of your organization. e.g. a paragraph from an about page on your company's website
25+
placeholder: List of Organizations
3726
validations:
3827
required: true
3928
- type: textarea
40-
id: team
29+
id: teams
4130
attributes:
42-
label: Team Description
43-
description: Describe your Team
44-
placeholder: Do you work for a central IT organization in your company? or for a team of a specific department?
45-
validations:
46-
required: true
47-
- type: textarea
48-
id: platform-topology-internal
49-
attributes:
50-
label: Internal Topology
51-
description: TBD
52-
placeholder: Describe your Internal Platform Engineering Team Topology
53-
validations:
54-
required: true
55-
- type: textarea
56-
id: platform-topology-external
57-
attributes:
58-
label: External Topology
59-
description: TBD
60-
placeholder: Describe your External Platform Engineering Team Topology
31+
label: Team(s)
32+
description: Describe the teams involved in this architecture
33+
placeholder: Developer Platforms, ...
6134
validations:
6235
required: true
6336
- type: textarea
6437
id: overview
6538
attributes:
6639
label: Overview and Goals
67-
description: TBD
68-
placeholder: Brief overview of your architecture and any potential goals you are trying to achieve with it?
40+
description: A brief overview of the goals of the implementation
41+
placeholder: Edge deployment for sensor tracking
6942
validations:
7043
required: true
7144
- type: textarea
72-
id: services
45+
id: projects
7346
attributes:
74-
label: Projects and Services
75-
description: TBD
76-
placeholder: Can you expand on why you are using those projects/services?
77-
validations:
78-
required: true
79-
- type: textarea
80-
id: successes
81-
attributes:
82-
label: Successful Lessons Learned
83-
description: TBD
84-
placeholder: What has worked well?
85-
validations:
86-
required: true
87-
- type: textarea
88-
id: improvements
89-
attributes:
90-
label: Improvements that could be made
91-
description: TBD
92-
placeholder: What has not worked well?
93-
validations:
94-
required: true
95-
- type: textarea
96-
id: glue
97-
attributes:
98-
label: Custom work and glue required
99-
description: TBD
100-
placeholder: What sort of "glue" have you had to develop to enable usage of your architecture? What have you done to have to get everything to work well together?e .g. have you written a bunch of helper scripts in bash? or maybe your own custom controller to manage a rollout?
47+
label: Projects
48+
description: List of projects being used in the proposed architecture (include all projects, also non CNCF projects)
49+
placeholder: Kubernetes, Helm, ArgoCD, ...
10150
validations:
10251
required: true
10352
- type: textarea
10453
id: evolution
10554
attributes:
106-
label: Updates and Changes
107-
description: TBD
108-
placeholder: Has your architecture evolved? What lessons did you learn from previous iterations?
109-
validations:
110-
required: true
111-
- type: textarea
112-
id: future
113-
attributes:
114-
label: What's next?
115-
description: TBD
116-
placeholder: What's next for your architecture? What are you looking to do next?
55+
label: Planned Evolution
56+
description: Any evolution planned for this reference architecture
57+
placeholder: Improvements in the area of networking and monitoring of edge devices
11758
validations:
11859
required: true

0 commit comments

Comments
 (0)