tfgrid/circle_product_management
26
0
Fork 0
Code Issues 68 Pull Requests Packages Projects Releases Wiki Activity

Reorganize ThreeFold Cloud Documentation: Separate User, Farmer, and Advanced Content #197

New Issue
Open
opened 2025-03-05 22:04:13 +00:00 by mik-tf · 0 comments
mik-tf commented 2025-03-05 22:04:13 +00:00
Owner
Copy Link

Context

Currently, the ThreeFold documentation at manual.grid.tf has become overly complex with too many parts and sections, creating confusion for users and farmers of different skill levels. We need to:

  • Simplify the ThreeFold Cloud product offering through clearer documentation structure
  • Create dedicated entry points for users and farmers
  • Separate basic documentation from advanced technical documentation
  • Implement Docusaurus in documentation for a modern UX

Stakeholders

  • Docs Team: Responsible for creating, organizing, and maintaining all documentation

URL Structure

  • manual.grid.tf: Welcome page with buttons leading to 3 subsections below
  • manual.grid.tf/user: Basic user documentation for deploying and using ThreeFold Grid services
  • manual.grid.tf/farmer: Basic farmer documentation for setting up and maintaining farms
  • manual.grid.tf/labs: Advanced technical documentation for both users and farmers

Requirements

User Basic Docs

  • Users can successfully deploy a VM following instructions
  • Users can set up web gateway following instructions
  • Users can configure mycelium following instructions
  • Users can configure wireguard following instructions
  • User FAQ and common use cases
  • Clear pathways for users to find advanced information at manual.grid.tf/labs when needed

Farmer Basic Docs

  • Clear instructions for setting up a ThreeFold farm
  • Basic farming operations are explained with step-by-step guidance
  • Farm maintenance procedures are clearly documented
  • Farmer FAQ and troubleshooting
  • Clear pathways for farmers to find advanced information at manual.grid.tf/labs when needed

Advanced Documentation

  • Comprehensive technical resource for both advanced users and farmers
  • Detailed development guides and advanced configurations
  • Experimental features

Technical Requirements

  • Docusaurus implementation
  • Uniform navigation and design across the three main sections
  • Mobile-friendly design for all sites
  • Functional search capability
  • Proper URL redirections to maintain existing links

Timeline

  • 3 weeks
    • Start: 25-03-06
    • End: 25-03-27

Deliverables

Common Features

The site will use Docusaurus with consistent navigation, search functionality, and cross-referencing between sections.

manual.grid.tf

  • Clear landing page that directs users to the appropriate section based on their role and technical needs

manual.grid.tf/user

  • Basic user documentation focused on getting started and common use cases

manual.grid.tf/farmer

  • Basic farmer documentation focused on farm setup and maintenance

manual.grid.tf/labs

  • Advanced documentation for users and farmers
## Context Currently, the ThreeFold documentation at manual.grid.tf has become overly complex with too many parts and sections, creating confusion for users and farmers of different skill levels. We need to: - Simplify the ThreeFold Cloud product offering through clearer documentation structure - Create dedicated entry points for users and farmers - Separate basic documentation from advanced technical documentation - Implement Docusaurus in documentation for a modern UX ## Stakeholders - **Docs Team**: Responsible for creating, organizing, and maintaining all documentation ## URL Structure - **manual.grid.tf**: Welcome page with buttons leading to 3 subsections below - **manual.grid.tf/user**: Basic user documentation for deploying and using ThreeFold Grid services - **manual.grid.tf/farmer**: Basic farmer documentation for setting up and maintaining farms - **manual.grid.tf/labs**: Advanced technical documentation for both users and farmers ## Requirements ### User Basic Docs - [ ] Users can successfully deploy a VM following instructions - [ ] Users can set up web gateway following instructions - [ ] Users can configure mycelium following instructions - [ ] Users can configure wireguard following instructions - [ ] User FAQ and common use cases - [ ] Clear pathways for users to find advanced information at manual.grid.tf/labs when needed ### Farmer Basic Docs - [ ] Clear instructions for setting up a ThreeFold farm - [ ] Basic farming operations are explained with step-by-step guidance - [ ] Farm maintenance procedures are clearly documented - [ ] Farmer FAQ and troubleshooting - [ ] Clear pathways for farmers to find advanced information at manual.grid.tf/labs when needed ### Advanced Documentation - [ ] Comprehensive technical resource for both advanced users and farmers - [ ] Detailed development guides and advanced configurations - [ ] Experimental features ### Technical Requirements - [ ] Docusaurus implementation - [ ] Uniform navigation and design across the three main sections - [ ] Mobile-friendly design for all sites - [ ] Functional search capability - [ ] Proper URL redirections to maintain existing links ## Timeline - 3 weeks - Start: 25-03-06 - End: 25-03-27 ## Deliverables ### Common Features The site will use Docusaurus with consistent navigation, search functionality, and cross-referencing between sections. ### manual.grid.tf - Clear landing page that directs users to the appropriate section based on their role and technical needs ### manual.grid.tf/user - Basic user documentation focused on getting started and common use cases ### manual.grid.tf/farmer - Basic farmer documentation focused on farm setup and maintenance ### manual.grid.tf/labs - Advanced documentation for users and farmers
mik-tf added the
Story
 label 2025-03-05 22:04:13 +00:00
mik-tf added the due date 2025-03-27 2025-03-05 22:04:30 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
  
Issue

   
Question

   
Roadmap

   
Story

   
Task

   
Urgent
No Label
Issue
Question
Roadmap
Story
Task
Urgent
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

2025-03-27

Dependencies

No dependencies set.

Reference: tfgrid/circle_product_management#197
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?