feat(discord): add Discord Integration project documentation
This commit is contained in:
parent
9a501cce3d
commit
e5429731f3
4 changed files with 148 additions and 0 deletions
30
projects/Discord Integration/CHANGELOG.md
Normal file
30
projects/Discord Integration/CHANGELOG.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# Changelog
|
||||
|
||||
## 2026-06-08
|
||||
|
||||
### Added
|
||||
|
||||
- Community panel added to the test portal.
|
||||
- Discord card added.
|
||||
- Discord icon added.
|
||||
- Discord invite link configured.
|
||||
- Discord Integration project folder created.
|
||||
|
||||
### Changed
|
||||
|
||||
- Portal layout adjusted to reduce negative space.
|
||||
- Knowledge Base, Development, and Community now align better.
|
||||
|
||||
### Verified
|
||||
|
||||
- Discord icon displays correctly.
|
||||
- Discord invite opens successfully.
|
||||
- Test portal remains operational.
|
||||
|
||||
### Planned
|
||||
|
||||
- Forgejo to Discord changelog automation.
|
||||
- #change-log Discord channel.
|
||||
- Authentik integration.
|
||||
- GitHub coming soon card.
|
||||
- Role-based onboarding.
|
||||
35
projects/Discord Integration/DEBUG-DOCUMENTATION.md
Normal file
35
projects/Discord Integration/DEBUG-DOCUMENTATION.md
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
# Discord Integration Debug Documentation
|
||||
|
||||
## Issue 1: Discord Icon Did Not Display
|
||||
|
||||
Cause:
|
||||
An SVG file was downloaded and saved with a .png filename.
|
||||
|
||||
Fix:
|
||||
Replaced it with a valid PNG file.
|
||||
|
||||
Verification:
|
||||
file discord.png
|
||||
|
||||
Expected result:
|
||||
PNG image data
|
||||
|
||||
## Issue 2: Discord Card Was Coming Soon
|
||||
|
||||
Cause:
|
||||
The card used href="#" and data-coming-soon="1".
|
||||
|
||||
Fix:
|
||||
Replaced the placeholder link with the Discord invite URL.
|
||||
|
||||
## Issue 3: Permission Denied Creating Documentation Folder
|
||||
|
||||
Cause:
|
||||
The kitestacks-homelab repository is owned by root:root.
|
||||
|
||||
Fix:
|
||||
Used sudo to create the project folder and documentation files.
|
||||
|
||||
## Notes
|
||||
|
||||
Always test in the portal test environment before promoting to production.
|
||||
33
projects/Discord Integration/README.md
Normal file
33
projects/Discord Integration/README.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# Discord Integration
|
||||
|
||||
## Purpose
|
||||
|
||||
Connect the KiteStacks website to the official KiteStacks Discord community.
|
||||
|
||||
## Current Status
|
||||
|
||||
Status: Implemented in test environment.
|
||||
|
||||
Test URL:
|
||||
http://192.168.1.205:3008
|
||||
|
||||
Discord Invite:
|
||||
https://discord.gg/QbdveTb6Kw
|
||||
|
||||
## Completed
|
||||
|
||||
- Added Community panel to the test portal.
|
||||
- Added Discord card.
|
||||
- Added Discord icon.
|
||||
- Connected Discord card to invite link.
|
||||
- Adjusted layout to reduce negative space.
|
||||
- Verified Discord invite works.
|
||||
|
||||
## Future Roadmap
|
||||
|
||||
- Create #change-log channel.
|
||||
- Configure Forgejo webhook notifications.
|
||||
- Add Discord announcement workflow.
|
||||
- Add Authentik integration.
|
||||
- Add role-based onboarding.
|
||||
- Add future GitHub card as coming soon.
|
||||
50
projects/Discord Integration/RUNBOOK.md
Normal file
50
projects/Discord Integration/RUNBOOK.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
# Discord Integration Runbook
|
||||
|
||||
## Test Portal
|
||||
|
||||
Directory:
|
||||
/home/kenpat/docker/kitestacks-portal-test
|
||||
|
||||
URL:
|
||||
http://192.168.1.205:3008
|
||||
|
||||
## Website Files Modified
|
||||
|
||||
public/index.html
|
||||
public/style.css
|
||||
public/images/icons/discord.png
|
||||
|
||||
## Discord Card
|
||||
|
||||
The Discord card is located in the Community panel.
|
||||
|
||||
Current invite:
|
||||
https://discord.gg/QbdveTb6Kw
|
||||
|
||||
## Access Workflow
|
||||
|
||||
Visitor opens KiteStacks website.
|
||||
Visitor clicks Discord.
|
||||
Visitor joins Discord server.
|
||||
Visitor reads welcome and rules.
|
||||
Visitor requests access.
|
||||
Admin approves user.
|
||||
Approved user receives member access.
|
||||
|
||||
## Planned Channels
|
||||
|
||||
Public:
|
||||
#welcome
|
||||
#rules
|
||||
#request-access
|
||||
|
||||
Member:
|
||||
#general
|
||||
#change-log
|
||||
#announcements
|
||||
#homelab-showcase
|
||||
|
||||
Admin:
|
||||
#staff
|
||||
#applications
|
||||
#moderation
|
||||
Loading…
Add table
Add a link
Reference in a new issue