From f9b50d7e81285bc66795c01ef441df1065b9facd Mon Sep 17 00:00:00 2001 From: Derek Cooper Date: Sat, 16 May 2026 00:08:50 -0700 Subject: [PATCH] updated some information for Dockhand --- preferences/articles.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/preferences/articles.md b/preferences/articles.md index 36ac4d3..1a75bb3 100644 --- a/preferences/articles.md +++ b/preferences/articles.md @@ -67,13 +67,15 @@ summary: "A brief 1–3 sentence description of what this post covers." ```markdown ## Prerequisites -- [Related Post Title](https://chns.tech/posts/...) — brief note on what it covers -- [Related Post Title](https://chns.tech/posts/...) — brief note on what it covers +- [Related Post Title](/posts/YYYY/slug/) — brief note on what it covers +- [Related Post Title](/posts/YYYY/slug/) — brief note on what it covers - Item describing required software, knowledge, or setup - Item ``` Search all existing posts in `/home/dockersa/chns.tech/content/posts/` and link **every** related published post (i.e., `draft: false`), not just one. Each linked post should include a brief note on what it covers. +Use relative paths (`/posts/YYYY/slug/`) when the linked post is on chns.tech. Use a full URL only for external sites. + ### 3. Main Content (H2 sections) - Use `##` for section headers, not `###` for primary sections - Sequential steps for tutorials — explain before showing code @@ -191,8 +193,10 @@ Most common post type. Structure: 6. **Conclusion** — personal thoughts, link to official docs/GitHub 7. **References** — official site, GitHub, Docker Hub -**Docker Compose block example:** -``` +**Docker Compose block — write inline YAML while drafting, replace with `remote-code` before publishing:** + +Draft (inline): +```yaml services: appname: image: imagename:latest @@ -206,6 +210,26 @@ services: restart: unless-stopped ``` +Pre-publish replacement (after compose file is committed to `CHNS/Docker-Compose` in Gitea): +``` +{{}} +``` + +**`.env` block — sensitive values (passwords, keys, tokens, webhook URLs) go in a `.env` file, not baked into the compose block:** + +Draft (inline): +```bash +DB_PASSWORD=changeme +APP_SECRET_KEY=changeme +WEBHOOK_URL=https://your-domain.com/webhook +``` + +Pre-publish replacement (after `.env.example` is committed to Gitea): +``` +{{}} +``` +Follow with a note on which values need to be changed before running. + --- ## Content DO's and DON'Ts