Reorganize Documentation

[biosafetylvl5]

[This is a DRAFT, please wait to read or get ready for some rough reading]

The Good Ones: Documentation to Be Inspired By

Kubernetes

• Documentation (general)
  • Versions, Getting Started Guides, Best Practices, Concepts, Administration, Windows in Kubernetes, Extending Kubernetes
• Getting started
  • Information on setting up learning and production environments, including best practices and various environment setups
• Concepts
  • Overviews, architecture, workloads, services, networking, storage, configuration, security, policy, scheduling, and cluster administration
• Tasks
  • Detailed tasks for installing tools, administering clusters, configuring pods and containers, running applications, and extending Kubernetes
• Tutorials
  • Step-by-step tutorials on using Minikube, learning Kubernetes basics, configuring and securing applications, managing stateless and stateful applications
• Reference
  • Comprehensive reference material on Kubernetes API, command-line tools, component tools, configuration APIs, external APIs, scheduling, and more
• Contribute
  • Guidelines on contributing to Kubernetes documentation, including how to suggest improvements, contribute new content, and participate in the community

    Pandas

• development: Documentation for contributing to the project.
  • Guidelines for community, contributing, debugging, etc.
  • gitpod-imgs: Images for Gitpod setup instructions.
• getting_started: Guides for new users.
  • comparison: Comparisons between pandas and other tools (R, SAS, SQL, Stata, spreadsheets).
  • intro_tutorials: Tutorials covering basic to advanced pandas functionalities.
• reference: Reference section for pandas functionalities.
  • Detailed documentation on arrays, frames, general functions, IO, indexing, and more.
• user_guide: In-depth higher level guides on pandas features
  • Topics from basic data structure introductions to advanced data manipulation and visualization.
• templates: HTML templates for documentation styling.

  Suggested Outline

• Getting started
  • System requirements
  • Installing
    • Various environment setups
      • Anaconda
      • "Expert Install"
      • Docker
      • Kubernetes .. etc.
    • Plugins
  • Best practices
• Contribute
  • PR/Issue Guidelines
  • Coding Standards
• Develop
  • (API, references, etc.)
• Concepts
  • Overviews, architecture, plugins, configuration, etc.
• Tutorials

[biosafetylvl5]

Planning done, superseded by #531