Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Chronologue docs: Requesting a new recording #12

Open
11 tasks
valeriahhdez opened this issue Jun 10, 2022 · 1 comment
Open
11 tasks

Chronologue docs: Requesting a new recording #12

valeriahhdez opened this issue Jun 10, 2022 · 1 comment
Assignees
@peterjurich
Labels
documentation Improvements or additions to documentation

Comments

@valeriahhdez
Copy link
Collaborator

valeriahhdez commented Jun 10, 2022 •
edited by kickoke
Loading

Summary

"Requesting a new recording" is a How-to guide that provides Scientists with an explanation of how to submit a new request for time-travel.

Research

  • Determine user goals.
  • Determine prerequisites
  • Determine what steps the user has to take.

Writing/Testing

  • Create a new branch.
  • Create a draft.
  • Write a commentary in the document to highlight best practices.
  • Take feedback notes for the template group.
  • Create a PR.

Review

  • Grammatical review.
  • Technical review.

Publication

  • Merge PR to docs.

Resources

Source file: https://github.com/thegooddocsproject/chronologue/blob/docs/docs/chronologue/t_requesting_a_new_recording.md
Template: https://github.com/thegooddocsproject/templates/tree/dev/how-to
Feedback form: INSERT LINK
@valeriahhdez valeriahhdez added the documentation Improvements or additions to documentation label Jun 10, 2022
@kickoke
Copy link
Collaborator

kickoke commented Jul 16, 2022

Updated the source file link, in case you want to start populating the Markdown file at any time @peterjurich.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@peterjurich peterjurich

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

When branches are created from issues, their pull requests are automatically linked.

12-chronologue-docs-requesting-a-new-recording thegooddocsproject/chronologue
3 participants
@kickoke @valeriahhdez @peterjurich