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

Documentation: Create readthedocs page for this repo #21

Open
16 tasks
jaredalee opened this issue Jan 27, 2025 · 4 comments
Open
16 tasks

Documentation: Create readthedocs page for this repo #21

jaredalee opened this issue Jan 27, 2025 · 4 comments
Assignees
Labels
component: documentation Documentation related issue priority: medium Medium Priority requestor: Multiscale NWP Team Multiscale NWP Team

Comments

@jaredalee
Copy link
Collaborator

Describe the Task

Create a readthedocs page/template for this repo. For now the left menu likely only needs two items: Overview (the initial content for which you can copy in the current README content from this repo), and User Instructions (content for which @jaredalee will take the initial lead on creating). Additional sections can be added later as needs develop. @jaredalee will make the repo public as a pre-requisite to completing this task.

Time Estimate

Less than 1 day

Relevant Deadlines

None

New Parameters

None

Technical References

None

Funding Source

Multiscale Workflow project

Define the Metadata

Assignee

  • Select appropriate assignee for this issue

Labels

  • Select component
  • Select priority
  • Select requestor(s)

Task Checklist

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of main.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into main.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@jaredalee jaredalee added component: documentation Documentation related issue priority: medium Medium Priority requestor: Multiscale NWP Team Multiscale NWP Team labels Jan 27, 2025
@jaredalee
Copy link
Collaborator Author

I just made this repo public. @jprestop, if there are any rulesets or security steps that should be implemented as a result of this now being a public repo, please advise/recommend.

@jprestop
Copy link
Collaborator

Thanks @jaredalee. I don't know of any off hand, but I'll take a look tomorrow and can follow up.

@jprestop
Copy link
Collaborator

Hi @jaredalee. In order to take a look at the settings and in order to set up Read the Docs, I need to be made an admin of this repo. Could you please make me an admin when you have a chance?

@jaredalee
Copy link
Collaborator Author

Done. You now have admin access for this repo, @jprestop.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation related issue priority: medium Medium Priority requestor: Multiscale NWP Team Multiscale NWP Team
Projects
None yet
Development

No branches or pull requests

2 participants