NCAR / NCAR/wrfcloud

Document S3 archive structure

Open
#39 0 comments 0 reactions 1 assignee View on GitHub

@fossell is already working on this.

Since May 1, 2023.

component: documentation priority: high required: FOR OFFICIAL RELEASE type: task
Dominant language
Python
Stars
18
Forks
6
No merged PRs in 30d

Description

Describe the Task

S3 will be used to store static input files as well as archiving forecast data. Need to document the directory structure and naming conventions of the S3 space.

Time Estimate

1 day

Sub-Issues

Consider breaking the task down into sub-issues.

  • Work offline on doc to finalize the organization
  • Add documentation reflecting the directory structure and naming conventions
Relevant Deadlines

Sep 30, 2022

Define the Metadata

Assignee
  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required
Labels
  • Select component(s)
  • Select priority
Projects and Milestone
  • Select Project
  • Select Milestone as the next official version or Backlog of Development Ideas

Task Checklist

  • Complete the issue definition above, including the Time Estimate.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>/<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s), Project, and Development issue
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.