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

Set up the FastEddy Tutorial documentation #3

Closed
4 tasks done
jprestop opened this issue Feb 23, 2024 · 1 comment · Fixed by #4, #5 or #7
Closed
4 tasks done

Set up the FastEddy Tutorial documentation #3

jprestop opened this issue Feb 23, 2024 · 1 comment · Fixed by #4, #5 or #7
Assignees
Labels
pillar: community Community pillar issue priority: high High Priority requestor: Multiscale NWP Team Multiscale NWP Team
Milestone

Comments

@jprestop
Copy link
Collaborator

Describe the Task

The Fast Eddy Tutorial documentation currently lives in the FastEddyTutorial GitHub repository. We'd like to bring the documentation into this repository to keep the documentation and the code together. The task is to:

  • Set up the documentation structure in this repository
  • Set up webhooks with Read the Docs
  • Set up continuous integration to automatically update the generated documentation on Read the Docs when changes are made to various branches of the repository.

Time Estimate

1-3 days of work

Relevant Deadlines

None

Define the Metadata

Assignee

  • Assign this Task to the appropriate person

Labels

  • Select pillar
  • Select priority
  • Select requestor(s)
@jprestop jprestop added pillar: community Community pillar issue priority: high High Priority requestor: Multiscale NWP Team Multiscale NWP Team labels Feb 23, 2024
@jprestop jprestop self-assigned this Feb 23, 2024
@jprestop jprestop linked a pull request Feb 23, 2024 that will close this issue
12 tasks
@jprestop
Copy link
Collaborator Author

Reopening as the work isn't complete, but I had to merge in the initial base level changes in order to set up Read The Docs at all. The issue was automatically closed when the PR was merged. Reopening this issue for continued work.

@jprestop jprestop reopened this Feb 23, 2024
@jprestop jprestop linked a pull request Feb 23, 2024 that will close this issue
12 tasks
jprestop added a commit that referenced this issue Feb 27, 2024
jprestop added a commit that referenced this issue Feb 27, 2024
jprestop added a commit that referenced this issue Feb 27, 2024
@jprestop jprestop changed the title Set up Read the Docs documentation Set up the FastEddy Tutorial documentation Feb 27, 2024
@jprestop jprestop linked a pull request Mar 25, 2024 that will close this issue
13 tasks
@jprestop jprestop added this to the FastEddy 1.1 milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pillar: community Community pillar issue priority: high High Priority requestor: Multiscale NWP Team Multiscale NWP Team
Projects
None yet
1 participant