Skip to content

Commit c0b5d0b

Browse files
committed
feat: update release infrastructure and documentation
- Update GitHub issue templates with standardized YAML format - Add automated release workflows and smoke testing - Enhance documentation with installation guides for Docker and Linux - Add comprehensive quickstart guide and release checklist - Update license and third-party attributions - Add MkDocs configuration for documentation site - Implement packaging infrastructure for multi-platform releases - Clean up staging artifacts and checksums - Update security documentation and troubleshooting guides - Add automated documentation deployment workflow
1 parent d44f03f commit c0b5d0b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+5107
-2421
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 72 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -63,57 +63,113 @@ body:
6363
required: true
6464

6565
- type: input
66-
id: version
66+
id: controller_version
6767
attributes:
68-
label: GlinrDock Version
69-
description: What version of GlinrDock are you running?
68+
label: Controller Version
69+
description: What version of GlinrDock Controller are you running?
7070
placeholder: v1.0.0
7171
validations:
7272
required: true
7373

74+
- type: textarea
75+
id: version_output
76+
attributes:
77+
label: Version Command Output
78+
description: |
79+
Please run `glinrdockd --version` and paste the complete output below.
80+
If using Docker Compose, run: `docker compose exec glinrdock glinrdockd --version`
81+
placeholder: |
82+
glinrdockd version v1.0.0
83+
Build: abc123def
84+
Built: 2025-01-01T12:00:00Z
85+
Go: go1.21.0
86+
render: shell
87+
validations:
88+
required: true
89+
7490
- type: dropdown
7591
id: installation
7692
attributes:
7793
label: Installation Method
7894
description: How did you install GlinrDock?
7995
options:
80-
- Install script (recommended)
96+
- systemd service (install script)
8197
- Docker Compose
82-
- Manual installation
98+
- Manual binary installation
99+
- Container (docker run)
83100
- Other (specify in additional context)
84101
validations:
85102
required: true
86103

87104
- type: input
88105
id: os
89106
attributes:
90-
label: Operating System
91-
description: What operating system are you using?
92-
placeholder: Ubuntu 22.04, CentOS 8, etc.
107+
label: Operating System and Version
108+
description: What operating system and version are you using?
109+
placeholder: "Ubuntu 22.04.3 LTS, CentOS Stream 8, macOS 13.6, etc."
93110
validations:
94111
required: true
95112

96113
- type: input
97114
id: docker
98115
attributes:
99116
label: Docker Version
100-
description: What version of Docker are you using?
101-
placeholder: Docker version 20.10.21
117+
description: What version of Docker are you using? (Run `docker --version`)
118+
placeholder: "Docker version 24.0.7, build afdd53b"
102119
validations:
103120
required: true
104121

105122
- type: textarea
106123
id: logs
107124
attributes:
108-
label: Log Output
125+
label: Log Output (Required)
109126
description: |
110-
Please provide relevant log output. For systemd installations use:
111-
`sudo journalctl -u glinrdock.service --no-pager -l`
127+
Please provide relevant log output from the time the issue occurred:
128+
129+
**For systemd installations:**
130+
```bash
131+
sudo journalctl -u glinrdockd.service --no-pager -l --since="10 minutes ago"
132+
```
133+
134+
**For Docker Compose:**
135+
```bash
136+
docker compose logs --tail=50 glinrdock
137+
```
112138
113-
For Docker Compose use:
114-
`docker-compose logs glinrdock`
115-
placeholder: Paste log output here...
139+
**For docker run:**
140+
```bash
141+
docker logs --tail=50 glinrdock
142+
```
143+
placeholder: Paste log output here (last 50 lines or relevant error messages)...
116144
render: shell
145+
validations:
146+
required: true
147+
148+
- type: textarea
149+
id: health_check
150+
attributes:
151+
label: Health Endpoint Output
152+
description: |
153+
Please check the health endpoint status by running:
154+
```bash
155+
curl -s http://localhost:8080/v1/health | jq .
156+
```
157+
Or without jq:
158+
```bash
159+
curl -s http://localhost:8080/v1/health
160+
```
161+
If the endpoint is not responding, note that in the output.
162+
placeholder: |
163+
{
164+
"status": "healthy",
165+
"timestamp": "2025-01-01T12:00:00Z",
166+
"version": "v1.0.0"
167+
}
168+
169+
OR: "Connection refused" / "Timeout" / other error message
170+
render: json
171+
validations:
172+
required: true
117173

118174
- type: textarea
119175
id: config

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Security Vulnerability
4-
url: https://github.com/GLINCKER/glinrdock-release/blob/main/SECURITY.md
5-
about: Report security vulnerabilities privately
6-
- name: General Discussion
3+
- name: 🔒 Security Vulnerability Report
4+
url: https://github.com/GLINCKER/glinrdock-release/blob/main/docs/SECURITY.md
5+
about: Report security vulnerabilities privately through our coordinated disclosure process
6+
- name: 📖 Documentation & Installation Help
7+
url: https://glincker.github.io/glinrdock-release/
8+
about: Visit our documentation site for installation guides and troubleshooting
9+
- name: 💬 General Discussion
710
url: https://github.com/GLINCKER/glinrdock-release/discussions
811
about: Ask questions and discuss features with the community
9-
- name: Documentation
10-
url: https://github.com/GLINCKER/glinrdock-release/blob/main/README.md
11-
about: Read the documentation and guides
12+
- name: 📞 Commercial Support
13+
url: mailto:support@glincker.com
14+
about: Contact GLINCKER LLC for enterprise support and licensing

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 67 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -32,27 +32,58 @@ body:
3232
validations:
3333
required: true
3434

35+
- type: textarea
36+
id: business_outcome
37+
attributes:
38+
label: Business Outcome & Impact
39+
description: |
40+
What business problem does this solve? What value would it provide?
41+
Focus on the "why" and business impact, not the "how".
42+
placeholder: |
43+
Example business outcomes:
44+
- "Reduce deployment time from 30 minutes to 5 minutes"
45+
- "Enable team to manage 50+ containers without manual oversight"
46+
- "Eliminate security compliance violations during container deployment"
47+
- "Save 10 hours per week on container monitoring tasks"
48+
49+
Describe the impact:
50+
- Who benefits from this feature?
51+
- How does it improve their workflow?
52+
- What are the measurable benefits?
53+
validations:
54+
required: true
55+
3556
- type: textarea
3657
id: problem
3758
attributes:
38-
label: Problem Statement
39-
description: What problem does this feature solve? What's the motivation?
59+
label: Current Problem/Gap
60+
description: |
61+
What specific problem or limitation currently prevents achieving the business outcome?
62+
Be specific about what doesn't work today.
4063
placeholder: |
41-
Is your feature request related to a problem? Please describe.
42-
Example: "I'm always frustrated when..."
64+
Current state description:
65+
- "Currently we have to manually..."
66+
- "There's no way to..."
67+
- "Users get frustrated because..."
68+
- "We lose time/money because..."
4369
validations:
4470
required: true
4571

4672
- type: textarea
47-
id: solution
73+
id: minimal_solution
4874
attributes:
49-
label: Proposed Solution
50-
description: Describe the solution you'd like to see implemented
75+
label: Minimal Viable Change
76+
description: |
77+
What is the smallest possible change that would deliver meaningful value?
78+
Think MVP - what's the 80/20 solution that provides the most impact with least complexity?
5179
placeholder: |
52-
Describe your proposed solution:
53-
- How should it work?
54-
- What should the user experience be?
55-
- Any specific implementation details?
80+
Minimal solution that would help:
81+
- "Just need a simple button to..."
82+
- "A basic API endpoint that returns..."
83+
- "A config option to enable/disable..."
84+
- "Show status in the UI so users can..."
85+
86+
This doesn't need to be the full solution, just the minimum that provides value.
5687
validations:
5788
required: true
5889

@@ -89,29 +120,40 @@ body:
89120
required: true
90121

91122
- type: dropdown
92-
id: priority
123+
id: business_priority
93124
attributes:
94-
label: Priority
95-
description: How important is this feature to you?
125+
label: Business Priority
126+
description: What's the business impact if this feature is not implemented?
96127
options:
97-
- Nice to have (would be useful)
98-
- Important (would significantly improve workflow)
99-
- Critical (blocking current work)
128+
- Low (nice to have, minor convenience improvement)
129+
- Medium (noticeable productivity/efficiency gain)
130+
- High (significant workflow blocker or competitive advantage)
131+
- Critical (major business process blocked or security/compliance issue)
100132
validations:
101133
required: true
102134

135+
- type: input
136+
id: timeline
137+
attributes:
138+
label: Business Timeline
139+
description: Is there a business deadline or timeline driving this request?
140+
placeholder: "Q2 2025 product launch, upcoming audit, team scaling to 50+ developers, etc."
141+
validations:
142+
required: false
143+
103144
- type: dropdown
104-
id: complexity
145+
id: user_impact
105146
attributes:
106-
label: Estimated Complexity
107-
description: How complex do you think this feature would be to implement?
147+
label: User Impact Scope
148+
description: How many users or teams would benefit from this feature?
108149
options:
109-
- Simple (minor change, quick to implement)
110-
- Medium (moderate effort, some design needed)
111-
- Complex (significant effort, major changes)
112-
- Unknown (not sure about implementation complexity)
150+
- Individual (just me or my specific use case)
151+
- Team (5-15 people on my team)
152+
- Department (multiple teams, 15-50 people)
153+
- Organization (company-wide, 50+ people)
154+
- Community (many external users would benefit)
113155
validations:
114-
required: false
156+
required: true
115157

116158
- type: textarea
117159
id: use_cases

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)