chore(install): adds install guide of signoz for haschicorp nomad

[Nageshbansal]

Related: https://github.com/SigNoz/platform-pod/issues/1061

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
signoz-web	Ready	Preview	Comment	Nov 24, 2025 3:00pm

[claude]

Claude finished @Nageshbansal's task —— View job

---

Review Complete: Install guide for HashiCorp Nomad

I've reviewed the new Nomad installation guide against the repository's CONTRIBUTING.md guidelines. The documentation is technically accurate and well-structured overall, but needs several improvements to meet the documentation standards.

Summary of Findings

✅ What's Working Well:

• Technical accuracy verified against the official SigNoz Nomad Pack
• Clear step-by-step instructions for installation
• Good coverage of prerequisites and configuration options
• Navigation entry correctly placed in docsSideNav.ts
• Proper use of code blocks with syntax highlighting

📋 Required Changes (per CONTRIBUTING.md):

1. Missing frontmatter: Add doc_type: howto field (data/docs/setup/nomad.mdx:4)
2. Missing Overview section: Add H2 "## Overview" before Prerequisites (data/docs/setup/nomad.mdx:10)
3. Section naming: Rename "Verify the Installation" to "## Validate" (data/docs/setup/nomad.mdx:168)
4. Missing Troubleshooting section: Add dedicated "## Troubleshooting" section with structured problem-solution format (data/docs/setup/nomad.mdx:152)
5. Expand Next Steps: Include links to instrumentation docs and related guides (data/docs/setup/nomad.mdx:237)

🔧 Style & Formatting Issues:

6. Link formatting: External links need proper <a> tag with security attributes (data/docs/setup/nomad.mdx:29)
7. Anchor text: Use descriptive link text instead of generic phrases (data/docs/setup/nomad.mdx:14)
8. Missing placeholder explanations: Add explanations for <your_release_name> and other placeholders after code blocks (data/docs/setup/nomad.mdx:42)

❓ Needs Clarification:

9. Configuration reference: The config variable description (line 201) needs verification—unclear if it's a disk path or configuration parameter

Minor Suggestions:

• Consider using "HashiCorp" (capital C) in the navigation label for brand consistency

Verification Sources

All technical details were verified against official sources:

• SigNoz Nomad Pack Repository
• HashiCorp Nomad Pack Documentation
• Nomad Docker Driver Documentation

PR Checklist Status

Comparing against the Docs PR Checklist:

• ❌ Frontmatter missing doc_type
• ✅ Tags include [Self-Host]
• ❌ Missing "Overview" section
• ✅ Commands explained appropriately
• ❌ Missing "Validate" section (has "Verify" instead)
• ❌ Troubleshooting needs expansion
• ❌ Next Steps section too brief
• ⚠️ External links need proper formatting
• ✅ Sidebar entry added correctly
• ✅ Code blocks properly formatted

Once these items are addressed, this will be a solid addition to the SigNoz documentation.

---

[therealpandey]

Suggested change

	route: '/docs/setup/nomad',
	route: '/docs/install/nomad',

Why setup?

[Nageshbansal]

Shouldn't we start adding new docs in setup only now

[makeavish]

Why?

[Nageshbansal]

The motive of the setup was to focus solely on the installation docs; we've been pushing docs to install/. My intention was to adapt to the new structure.

[makeavish]

Update this page

[makeavish]

Could have broken down this into multiple pages to make it simple?