Skip to content

Commit

Permalink
syncing local and remote kyber/readme.md updates
Browse files Browse the repository at this point in the history
several updates were made by me direct to main
  • Loading branch information
stefaniebutland committed Jan 8, 2025
1 parent 3aa4b2d commit 991f893
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ repo_path <- init_repo(repo_name)
# Then render the README.Rmd to README.md
render(path(repo_path, "README.Rmd"))

# To create a readme independently of creating a repo use: `kyber::create_readme()`, which is called by `init_repo()`. Then knit the README.Rmd to README.md.

# We still need to work out the next part of the workflow and the extent to
# which it should be automated, but I imagine something like:
#
Expand Down Expand Up @@ -282,10 +284,12 @@ kyber::call_agenda(
call_number = 4)
```

1. To review the call agenda, open `agenda.md`, click Preview, and view it in the Viewer Tab.
6. To review the call agenda, open `agenda.md`, click Preview, and view it in the Viewer Tab.

Usually you can repeat steps 3-5 whenever you make edits you want to review, however if there are problems try restarting you R session.

To update the template for all Cohort README.Rmd's, edit [`inst/rmarkdown/templates/openscapes-cohort-readme/skeleton/skeleton.Rmd`](https://github.com/Openscapes/kyber/blob/main/inst/rmarkdown/templates/openscapes-cohort-readme/skeleton/skeleton.Rmd)

## Contributing to Kyber

To contribute to Kyber, fork the repo, unchecking the "Copy the main branch only" box. Start working from the `dev` branch, create a new branch like `new-branch dev`, and then submit Pull Requests to `dev`. If using Git on the command line the workflow would look like:
Expand All @@ -298,5 +302,4 @@ To contribute to Kyber, fork the repo, unchecking the "Copy the main branch only
- then `git push origin new-branch`
- keep adding, committing, and pushing, then when you're ready open a PR

We started using this workflow when the [California Water Boards Openscapes]((https://cawaterboarddatacenter.github.io/swrcb-openscapes/) team began using Kyber to create Agendas from some unique source Rmd files. For example, Water Boards Cohort Calls are 2 hours, not the default 1.5 hrs, their lesson order is different from Openscapes Core Lessons, and includes a new lesson on Documentation.

We started using this workflow when the [California Water Boards Openscapes](https://cawaterboarddatacenter.github.io/swrcb-openscapes/) team began using Kyber to create Agendas from some unique source Rmd files. For example, Water Boards Cohort Calls are 2 hours, not the default 1.5 hrs, their lesson order is different from Openscapes Core Lessons, and includes a new lesson on Documentation.

0 comments on commit 991f893

Please sign in to comment.