Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Contributor Documentation #1137

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from
Draft

Adds Contributor Documentation #1137

wants to merge 16 commits into from

Conversation

swainn
Copy link
Member

@swainn swainn commented Dec 26, 2024

Description

This pull request adds documentation for contributors to Tethys Platform.

Draft:

  • Introduction / Landing Page (contribute.rst)
  • Contributing Code Overview (contribute/code.rst)
    • Getting Started Tutorial (contribute/getting_started.rst)
    • Setting up a development environment (contribute/dev_environment.rst)
    • Development Process (contribute/development_process.rst)
      • Testing (contribute/testing.rst)
    • Managing Issues (contribute/issues.rst)
    • Coding Principles (contribute/coding_principles.rst)
      • Tethys Core (contribute/coding_principles/core.rst)
      • Tethys CLI (contribute/coding_principles/cli.rst)
      • Tethys Compute (contribute/coding_principles/compute.rst)
      • Tethys Gizmos (contribute/coding_principles/gizmos.rst)
      • Tethys Layouts (contribute/coding_principles/layouts.rst)
      • Tethys Portal (contribute/coding_principles/tethys_portal.rst)
      • Code Organization (contribute/coding_principles/organization.rst)
    • Maintaining Dependencies (contribute/dependencies.rst)
    • Deploying New Versions (contribute/deploying_tethys.rst)
  • Contributing Documentation (contribute/documentation.rst)
    • Building the Docs
    • Source Files
    • Guidelines
    • Demo
    • I18n
  • Supporting the Community (contribute/community.rst)

Reviewed:

  • Introduction / Landing Page (contribute.rst)
  • Contributing Code Overview (contribute/code.rst)
    • Getting Started Tutorial (contribute/getting_started.rst)
    • Setting up a development environment (contribute/dev_environment.rst)
    • Development Process (contribute/development_process.rst)
      • Testing (contribute/testing.rst)
    • Coding Principles (contribute/coding_principles.rst)
      • Tethys Core (contribute/coding_principles/core.rst)
      • Tethys CLI (contribute/coding_principles/cli.rst)
      • Tethys Compute (contribute/coding_principles/compute.rst)
      • Tethys Gizmos (contribute/coding_principles/gizmos.rst)
      • Tethys Layouts (contribute/coding_principles/layouts.rst)
      • Tethys Portal (contribute/coding_principles/tethys_portal.rst)
      • Code Organization (contribute/coding_principles/organization.rst)
    • Maintaining Dependencies (contribute/dependencies.rst)
    • Deploying New Versions (contribute/deploying_tethys.rst)
  • Contributing Documentation (contribute/documentation.rst)
    • Building the Docs
    • Source Files
    • Guidelines
    • Demo
    • I18n
  • Supporting the Community (contribute/community.rst)

@coveralls
Copy link

coveralls commented Dec 26, 2024

Coverage Status

coverage: 99.973%. remained the same
when pulling 37ad9e1 on contributor-documentation
into e95effb on main.

@swainn swainn force-pushed the contributor-documentation branch from 6ad9a29 to 22a0f10 Compare January 3, 2025 01:01
@swainn swainn requested review from jcreerAquaveo and removed request for jcreerAquaveo January 9, 2025 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants