Skip to content

Instantly share code, notes, and snippets.

@jasenmichael
Last active April 19, 2022 15:55
Show Gist options
  • Save jasenmichael/c1f9eaa9f39a528515c2bcdd6d3d7470 to your computer and use it in GitHub Desktop.
Save jasenmichael/c1f9eaa9f39a528515c2bcdd6d3d7470 to your computer and use it in GitHub Desktop.

this is a likely folder structure:

/docs/ << all dirs in docs are added as categories
  ./[category]/
    ./[section]/   << all dirs in category are added as category sections
      ./[article].md  << all .md files in section are added as section articles

EXAMPLE:

/docs/
  ./pop-os
    ./user-education
      ./Live-Disk-Creation-Pop-OS.md
      ./Package-Manager-Issues-Pop-OS.md
  ./general
    ./anouncements
      ./Sample-article-Stellar-Skyonomy-refund-policies.md
      ./Welcome-to-your-Help-Center.md
    ./faq
      ./Before-You-Open-a-Ticket.md
      ./How-can-agents-leverage-knowledge-to-help-customers.md
      ./How-do-I-publish-my-content-in-other-languages.md
      ./What-are-these-sections-and-articles-doing-here.md

new articles will look something like this:

---
  title: Live Disk Creation Pop_OS!
---

# Heading

body...

When a merge to main occurs, gh action will get a list of - new, modified, renamed, moved, and deleted .md files.

a new file will:

  • ensure the category and section exists in ZDHC
  • create a new article, get the article id
  • add article id to frontmatter of markdown file, commit
  • the new file/article will be updated to look something like this
---
  id: 5396587753371
  title: Live Disk Creation Pop_OS!
---

# Heading

body...

a modified, renamed or moved file will:

  • ensure the category and section exists in ZDHC
  • remove any categories/sections in ZDHC if the folder does NOT exist in docs/
  • update the article by id

a removed/deleted file will:

  • remove any categories/sections in ZDHC if the folder does NOT exist in docs/
  • delete article by id
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment