Skip to content

docs: reorganize site with persona-first navigation#42

Merged
ShawnMcKee merged 1 commit intomasterfrom
docs/persona-first-navigation
Dec 7, 2025
Merged

docs: reorganize site with persona-first navigation#42
ShawnMcKee merged 1 commit intomasterfrom
docs/persona-first-navigation

Conversation

@ShawnMcKee
Copy link
Contributor

Overview

This PR reorganizes the OSG Networking documentation to use a persona-first navigation structure, making it easier for users to find relevant documentation based on their goals rather than technical categories.

What Changed

1. Homepage Redesign (docs/index.md)

  • Card-based "Get Started" section with three clear user journeys:
    • 🚀 Deploy perfSONAR (30-60 min, systems administrator)
    • 🔧 Troubleshoot Network Issues (variable time, network operator)
    • 🔭 Understand the System (reading/reference, developer/researcher)
  • Each card includes time estimates and skill level indicators
  • Streamlined Network Services section with current status
  • Added deprecation notice for MaDDash (directing to WLCG Grafana)
  • Cleaner Support and Quick Links sections

2. Navigation Restructure (mkdocs.yml)

  • New top-level "Get Started" section highlighting persona landing pages
  • perfSONAR Guides section with clear hierarchy:
    • Quick Deploy (recommended) listed before Legacy Installation
    • Legacy Installation clearly marked as "Archive"
  • New "Host Tuning" section consolidating tuning docs
  • Better organized "Tools & Scripts" section
  • "Advanced" section for security features, architecture, and release notes
  • Enabled Material theme features:
    • Navigation tabs and sections
    • Breadcrumb paths
    • Integrated table of contents
    • Copy code buttons

3. Legacy Documentation Updates (docs/perfsonar/installation.md)

  • Added prominent warning banner at the top
  • Clear direction to modern Quick Deploy guide for new installations
  • Explains this guide is maintained for existing Toolkit installations

Benefits

Clearer user journeys - visitors can quickly identify the right documentation path
Reduced confusion - legacy vs. modern approaches are clearly distinguished
Better discoverability - important tools and automation are more visible
Improved navigation UX - breadcrumbs, tabs, and better hierarchy
Current information - deprecated services clearly marked

Testing

  • Site builds successfully with mkdocs build
  • All internal links are valid
  • Navigation structure is logical and complete
  • Material theme features render correctly

Breaking Changes

None. This is a documentation reorganization only - no functional changes to scripts or tools.

Related Issues

Addresses user feedback about difficulty finding the right installation guide and confusion between legacy Toolkit and modern Testpoint deployment approaches.


Note: This maintains all existing content and links - it simply reorganizes how users navigate to find what they need.

- Restructure index.md to highlight user journey personas (Deploy, Troubleshoot, Research)
- Add card-based Get Started section with time estimates and skill levels
- Reorganize mkdocs.yml nav to persona-first structure with clearer hierarchy
- Enable Material theme navigation features (tabs, sections, breadcrumbs, TOC)
- Add prominent deprecation banner to legacy installation.md directing to Quick Deploy
- Update Network Services section with current service status
- Streamline Support and References sections for better accessibility
- Mark MaDDash as deprecated in favor of WLCG Grafana dashboards

This improves user experience by organizing content around common tasks
rather than technical categories, making it easier for users to find
the right documentation for their needs.
@ShawnMcKee ShawnMcKee merged commit fa800c5 into master Dec 7, 2025
7 checks passed
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