-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.Rmd
55 lines (47 loc) · 2.32 KB
/
index.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
---
title: "FIMS Developer Handbook"
author: "FIMS Implementation Team"
date: "`r Sys.Date()`"
site: bookdown::bookdown_site
documentclass: book
bibliography: [book.bib, packages.bib]
# url: your book url like https://bookdown.org/yihui/bookdown
# cover-image: path to the social sharing image like images/cover.jpg
description: |
This is a handbook for FIMS developers and contributors.
link-citations: yes
github-repo: noaa-fims/collaborative_workflow
favicon: "favicon/favicon.ico"
---
# Contributing to this book
This is a book written in **Markdown** describing the FIMS development
workflow for FIMS developers and contributors. It is intended as a
living document and will change over time as the FIMS project matures.
Some sections may be incomplete or missing entirely. Suggestions or
contributions may be made via the FIMS collaborative workflow github site
<https://github.com/NOAA-FIMS/collaborative_workflow>. This section describes how to edit
and contribute to the book.
## Description
Each **bookdown** chapter is an .Rmd file, and each .Rmd file can
contain one or more chapters. A chapter *must* start with a first-level
heading: `# A good chapter`, and can contain one (and only one)
first-level heading.
Use second-level and higher headings within chapters like:
`## A short section` or `### An even shorter section`.
The `index.Rmd` file is required, and is also your first book chapter.
It will be the homepage when you render the book.
## Edit and preview book changes
When you want to make a change to this book, follow the below steps:
1. Create a new feature branch either from the issue requesting the
change or from the repo on Github.
2. Pull the remote branch into your local branch and make your changes
to the .Rmd files locally.
3. When you are done editing, do not render the book locally, but push
your changes to the remote feature branch.
4. Pushing to the remote feature branch initiates a Github action that
creates a .zip file you should download and unzip. Open the file
index.html in a browser to preview the rendered .html content. If the
action fails, this means the bookdown could not be rendered. Use the
Github action log to determine what the problem is.
5. When the book can be rendered and you are satisfied with the changes,
submit a pull request to merge the feature branch into `main`.