Skip to content

Commit 4a23197

Browse files
refactor: organize services into categories
- move service implementations to categorized subdirectories under pkg/services/ - reorganize documentation structure to match categorized directories under docs/services/ - update service map imports to reference new categorized paths - modify generator imports for router and xoauth2 components - update mkdocs configuration to reflect new documentation structure - revise service overview to group services by category - update documentation generation script to handle categorized directories - adjust slack guide links to accommodate reorganized structure
1 parent d2dd53e commit 4a23197

File tree

170 files changed

+236
-189
lines changed

Some content is hidden

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

170 files changed

+236
-189
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ coverage.txt
2525
*.coverprofile
2626
dist
2727
site/
28-
docs/services/*/config.md
28+
docs/services/*/*/config.md

build/mkdocs/mkdocs.yaml

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -113,34 +113,35 @@ nav:
113113
- Go Package: usage/go-package/index.md
114114
- Services:
115115
- Overview: services/overview.md
116-
- Messaging:
117-
- Discord: services/discord/index.md
118-
- Google Chat: services/googlechat/index.md
119-
- Hangouts: services/hangouts/index.md
120-
- Lark: services/lark/index.md
121-
- Matrix: services/matrix/index.md
122-
- Mattermost: services/mattermost/index.md
123-
- Rocketchat: services/rocketchat/index.md
124-
- Signal: services/signal/index.md
125-
- Slack: services/slack/index.md
126-
- Teams: services/teams/index.md
127-
- Telegram: services/telegram/index.md
128-
- WeCom: services/wecom/index.md
129-
- Zulip Chat: services/zulip/index.md
130-
- Webhooks:
131-
- Generic Webhook: services/generic/index.md
132-
- IFTTT: services/ifttt/index.md
133-
- Push Notifications:
134-
- Bark: services/bark/index.md
135-
- Gotify: services/gotify/index.md
136-
- Join: services/join/index.md
137-
- Ntfy: services/ntfy/index.md
138-
- Pushbullet: services/pushbullet/index.md
139-
- Pushover: services/pushover/index.md
140-
- Other:
141-
- Email: services/email/index.md
142-
- Logger: services/logger/index.md
143-
- OpsGenie: services/opsgenie/index.md
116+
- Chat and Messaging Platforms:
117+
- Discord: services/chat/discord/index.md
118+
- Google Chat: services/chat/googlechat/index.md
119+
- Hangouts: services/chat/hangouts/index.md
120+
- Lark: services/chat/lark/index.md
121+
- Matrix: services/chat/matrix/index.md
122+
- Mattermost: services/chat/mattermost/index.md
123+
- Rocket.Chat: services/chat/rocketchat/index.md
124+
- Signal: services/chat/signal/index.md
125+
- Slack: services/chat/slack/index.md
126+
- Teams: services/chat/teams/index.md
127+
- Telegram: services/chat/telegram/index.md
128+
- WeCom: services/chat/wecom/index.md
129+
- Zulip: services/chat/zulip/index.md
130+
- Push Notification Services:
131+
- Bark: services/push/bark/index.md
132+
- Gotify: services/push/gotify/index.md
133+
- IFTTT: services/push/ifttt/index.md
134+
- Join: services/push/join/index.md
135+
- Ntfy: services/push/ntfy/index.md
136+
- Pushbullet: services/push/pushbullet/index.md
137+
- Pushover: services/push/pushover/index.md
138+
- Incident and Alert Management:
139+
- OpsGenie: services/incident/opsgenie/index.md
140+
- Email Services:
141+
- SMTP: services/email/smtp/index.md
142+
- Specialized Services:
143+
- Generic: services/specialized/generic/index.md
144+
- Logger: services/specialized/logger/index.md
144145
- Guides:
145146
- Configuring Slack: guides/slack/index.md
146147
- Proxy Setup: guides/proxy/index.md
@@ -159,6 +160,7 @@ plugins:
159160
# Displays last updated dates on pages, formatted as time ago.
160161
- git-revision-date-localized:
161162
enable_creation_date: true
163+
enable_git_follow: false
162164
type: timeago
163165

164166
# Build Directories: https://www.mkdocs.org/user-guide/configuration/#build-directories

docs/guides/slack/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

5-
Guides for setting up the [Slack](../../services/slack/index.md) service, including obtaining tokens (Bot API or Webhook) and channel IDs. The Slack service supports customization options like bot name, icon, color, title, and threading.
5+
Guides for setting up the [Slack](../../services/chat/slack/index.md) service, including obtaining tokens (Bot API or Webhook) and channel IDs. The Slack service supports customization options like bot name, icon, color, title, and threading.
66

77
## Getting a Token
88

@@ -18,7 +18,7 @@ To send messages, use either a Bot API token (preferred for full features) or a
1818
<figure><img alt="Copy OAuth token screenshot" src="app-api-copy-oauth-token.png" height="209" /></figure>
1919
<!-- markdownlint-restore -->
2020
!!! example
21-
Given the API token `xoxb-123456789012-1234567890123-4mt0t4l1YL3g1T5L4cK70k3N` and channel ID `C001CH4NN3L` (obtained via the [guide below](#getting-the-channel-id)), the Shoutrrr URL should look like:
21+
Given the API token `xoxb-123456789012-1234567890123-4mt0t4l1YL3g1T5L4cK70k3N` and channel ID `C001CH4NN3L` (obtained via the [Slack service docs](../../services/chat/slack/index.md#getting_the_channel_id)), the Shoutrrr URL should look like:
2222
```url
2323
slack://xoxb:123456789012-1234567890123-4mt0t4l1YL3g1T5L4cK70k3N@C001CH4NN3L
2424
```

docs/services/bark/index.md

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

docs/services/discord/index.md renamed to docs/services/chat/discord/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To send messages to a specific thread in a Discord channel, include the `thread_
2121

2222
You can obtain the `thread_id` by right-clicking a thread in Discord and selecting "Copy ID" (requires Developer Mode to be enabled in Discord settings).
2323

24-
--8<-- "docs/services/discord/config.md"
24+
--8<-- "docs/services/chat/discord/config.md"
2525

2626
## Creating a webhook in Discord
2727

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)