Skip to content

bug: Fix deployment issue of landing page 🐛 #788

Merged
tungbq merged 12 commits into
mainfrom
bug/fix-deploy-issue
Jul 5, 2026
Merged

bug: Fix deployment issue of landing page 🐛 #788
tungbq merged 12 commits into
mainfrom
bug/fix-deploy-issue

Conversation

@tungbq

@tungbq tungbq commented Jul 5, 2026

Copy link
Copy Markdown
Owner

Closes: #XXX

Be noted that XXX is the issue ID

What is the purpose of the change

Add a description of the overall background and high level changes that this PR introduces

(E.g.: This pull request improves documentation of area A by adding ....)

tungbq and others added 12 commits July 5, 2026 17:28
Add two new DevOps topics — OpenTofu (open-source Terraform fork) and
HashiCorp Vault (secrets management) — each with README, basics hello-world
script, and practice directory, following the existing topic structure.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
Add new DevOps topic for Trivy (open-source vulnerability/security scanner)
with README, basics demo script, and practice directory, following the
existing topic structure.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
Add new DevOps topic for Google Cloud Platform (GCP) with README, basics
hello-world script, and practice directory, following the existing topic
structure.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
Add three issue templates — bug report, content improvement, and new topic
request — to standardize contributor issue submissions.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
Add mkdocs.yml config, requirements-docs.txt, and a deploy-docs GitHub
Actions workflow to build and publish the documentation site.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
- Add Learning Paths section (5 role-based paths: Beginner, Platform Engineer, SRE, Cloud, DevSecOps)
- Add 4 new topics to topics table: Vault, OpenTofu, Trivy, GCP
- Update topic count from "30+" to "40+"
- Highlight security-first capability (Vault, Trivy, Snyk, SonarQube)
- Link to new ROADMAP.md from topics section
- Add ROADMAP.md with upcoming topics, planned improvements, and learning paths

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
Build a full-bleed hero home page using MkDocs Material overrides:
- overrides/home.html: hero section with gradient/glow, animated stats bar,
  CTA buttons, feature cards, 8-category grid, learning trio, and final CTA
- docs/stylesheets/extra.css: complete design system — CSS variables, hero
  layout, feature/category/trio cards, responsive breakpoints, hover effects
- docs/javascripts/extra.js: live GitHub star count via API with animated
  counter on scroll into view
- docs/index.md: home page frontmatter activating the custom template
- mkdocs.yml: wired extra CSS/JS and home page to docs/index.md

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
Phase 2 - Topic Cards Showcase:
- Add topics/index.md with Material grid cards for all 40+ topics
  organized into 8 categories with icons, descriptions, and links
- Wire as "All Topics" entry in nav

Phase 3 - Visual Polish & Branding:
- Switch palette from indigo to teal/cyan (modern tech feel)
- Add Inter (text) and JetBrains Mono (code) fonts
- Enhance Material grid card hover lift + teal border glow
- Zebra-stripe tables, rounded admonitions, styled headings
- Add copyright and footer to mkdocs.yml
- Color-coded tag icons per category

Phase 4 - Navigation & Search UX:
- Add navigation.path (breadcrumbs) feature
- Add navigation.indexes for section index pages
- Add tags plugin with tags.md index page
- Add tags/index page for browsing by category tag

Phase 5 - Performance & SEO:
- Add mkdocs-minify-plugin (HTML/JS/CSS compression)
- Add --clean flag to gh-deploy to remove stale files
- Add print media query to hide decorative sections
- docs/index.md already has full Open Graph metadata (from Phase 1)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
Conflicts in README.md, mkdocs.yml, requirements-docs.txt, and
deploy-docs.yml resolved by keeping the all-phases branch (HEAD) for
every conflict: teal/cyan theme, Inter font, tags + minify plugins,
navigation.path, --clean deploy with GA key, and the Vault/OpenTofu/
Trivy/GCP README rows from this branch.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
Three errors from the deploy workflow:

1. docs_dir: . → docs_dir: docs
   MkDocs no longer allows docs_dir to be the parent directory of
   mkdocs.yml. Changed to docs/ subdirectory.

2. site_dir conflict
   site/ was inside docs_dir (root). Now that docs_dir is docs/, site/
   sits at the repo root and is no longer nested inside it.

3. tags_file deprecated → removed
   Replaced `tags_file: tags.md` with bare `- tags` plugin entry, and
   removed the Tags nav entry that depended on it.

Also added a workflow step that symlinks repo-root content trees
(topics/, getting-started/, projects/, troubleshooting/, CONTRIBUTING.md,
ROADMAP.md) into docs/ before the build so MkDocs can resolve all nav
paths without moving any files.

Updated extra_css/extra_javascript paths from docs/stylesheets/ and
docs/javascripts/ to stylesheets/ and javascripts/ (now relative to
docs_dir).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
mkdocs.yml conflicts (2 blocks):
- tags plugin: keep bare `- tags` (tags_file is deprecated; origin/main
  still had the old tags_file entry)
- extra_css/extra_javascript/nav: keep HEAD paths relative to docs_dir
  (stylesheets/, javascripts/, index.md, topics/README.md) over
  origin/main's root-relative paths (docs/stylesheets/, docs/index.md)
- Also removed auto-merged `- Tags: tags.md` nav entry from origin/main
  (no longer valid without tags_file)

deploy-docs.yml conflict (1 block):
- Keep HEAD's symlink step that wires repo-root content into docs/ before
  the build — missing from origin/main

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
@tungbq
tungbq merged commit f4ac939 into main Jul 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant