Skip to content

Commit e920c72

Browse files
committed
Restructuring of book, revision of heading titles, and fixing links in ruby_on_rails_application_overview.md.
1 parent 149114f commit e920c72

5 files changed

+24
-15
lines changed

_bookdown.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,6 @@ rmd_files: ["overview.md",
3434
"complex_joins_in_the_web_interface.md",
3535
"database_constraints.md",
3636
"modifying_bety_schema.md",
37-
"issuing_a_new_release.md"]
37+
"issuing_a_new_release.md",
38+
#appendix
39+
"release_notes_template.md"]

betydb_development.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# BETYdb Development
1+
# (PART) BETYdb Development {-}
2+
3+
# Ruby on Rails Application Overview (draft)
24

35
_This is a Draft_
46

issuing_a_new_release.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Issuing a new release of the BETYdb Rails application
1+
# Issuing a New Release
22

33
From time to time, or whenever an important and needed code change is made, the
44
principle maintainer of the BETYdb Rails application should issue a new release

release_notes_template.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# (PART) Appendix {-}
2+
3+
# Release Notes Template {-}
4+
5+
```
16
[one line summary]
27
38
[full summary]
@@ -66,3 +71,4 @@ The database version for this release is [migration id].
6671
```
6772
6873
Complete instructions for setting up the test database and running the RSpec tests are on the Wiki page at https://github.com/PecanProject/bety/wiki/Automated-Tests
74+
```

ruby_on_rails_application_overview.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
# Ruby on Rails Application Overview
2-
1+
<!-- Possibly rename this file -->
32
# Ruby-on-Rails: Developing, Upgrading, and Deploying
43

54
## Development and Testing
65

7-
Testing is an integral part of releasing a new version of the BETYdb Rails app. Developers should test prospective code on their development machines prior to submitting a pull request, and code managers should re-test the code before accepting a pull request. See [[running the automated tests | automated-tests]] for complete testing instructions.
6+
Testing is an integral part of releasing a new version of the BETYdb Rails app. Developers should test prospective code on their development machines prior to submitting a pull request, and code managers should re-test the code before accepting a pull request. See [Automated Tests] for complete testing instructions.
87

98

109
## Deploying a new version:
1110

12-
**For up-to-date instructions on making a new release, see https://dlebauer.gitbooks.io/betydb-documentation/content/management/making_a_new_release.html**
11+
**For up-to-date instructions on making a new release, see [Issuing a New Release].**
1312

14-
At the end of each sprint (or set of sprints, or when ready to deploy a new version), the version should be tagged, and a "release" should be created. See the [[Release Notes Template | Release-Notes-Template]] page for a sample draft of release notes.
13+
At the end of each sprint (or set of sprints, or when ready to deploy a new version), the version should be tagged, and a "release" should be created. See the [Release Notes Template] page for a sample draft of release notes.
1514

1615

1716
(We use the terms "deploy" and "upgrade" roughly synonymously, but "deploy" connotes what code manager does when providing a new version of BETYdb to, say, the production server, and "upgrade" connotes what developers maintaining their own copies of BETYdb do to keep those copies up-to-date. Making a new "release" is part of the deployment process but is not part of the upgrade process for individual users.
@@ -76,9 +75,9 @@ If you do not wish to install the test pieces you can run `bundle install --with
7675
[Note: If you can't or don't wish to install the capybara-webkit gem, you can comment it out in the Gemfile. It is only needed for testing the RSpec tests and it is only needed for a few of them. To avoid running the tests that require it, run rspec with the "--tag ~js" option.]
7776

7877

79-
At this point, the site can be tested, both through the browser and by running the [[automated tests]]. [To do: write hints for running automated tests on production servers]
78+
At this point, the site can be tested, both through the browser and by running the [Automated Tests]. [To do: write hints for running automated tests on production servers]
8079

81-
_reference:_ [protocol for pull requests, testing etc. were discussed in [#48](https://github.com/PecanProject/bety/issues/48)]
80+
_reference:_ [protocol for pull requests, testing etc. were discussed in [bety issue #48](https://github.com/PecanProject/bety/issues/48){target="_blank"}]
8281

8382
### Running Migrations
8483

@@ -118,7 +117,7 @@ deployments of the BetyDB database should have precisely the same
118117
structure. But in case they do not, we want to capture what is
119118
actually be used live.)
120119

121-
Note that we no longer use the `schema.rb` file (see https://github.com/PecanProject/bety/issues/44). The `structure.sql` files allow for complete documentation of the database structure, including features that (by default) are not expressible in the `schema.rb` file. <strong>production_structure.sql is the canonical specification of the complete database schema, the schema which the Rails code is meant to be run against.</strong>
120+
Note that we no longer use the `schema.rb` file (see [bety issue #44](https://github.com/PecanProject/bety/issues/44){target="_blank"}). The `structure.sql` files allow for complete documentation of the database structure, including features that (by default) are not expressible in the `schema.rb` file. <strong>production_structure.sql is the canonical specification of the complete database schema, the schema which the Rails code is meant to be run against.</strong>
122121

123122
## Versioning and Tagging
124123

@@ -129,7 +128,7 @@ Note that we no longer use the `schema.rb` file (see https://github.com/PecanPro
129128
1. Merge pull requests into the master branch of PecanProject/bety as
130129
necessary (in order to avoid conflicts, preferably within one working
131130
day) .
132-
1. [to-do: clarify how we handle pre-releases and why they are necessary] Create a [pre-release](https://github.com/PecanProject/bety/releases/new). This should include a list of key expected features to be implemented during the sprint.
131+
1. [to-do: clarify how we handle pre-releases and why they are necessary] Create a [pre-release](https://github.com/PecanProject/bety/releases/new){target="_blank"}. This should include a list of key expected features to be implemented during the sprint.
133132
1. If critical bug fix is required on production server:
134133
1. Create a branch off of the currently-deployed master version. (If subsequent critical bug fixes are later needed, they can also go on this branch.)
135134
1. Apply the bug fix to the branch.
@@ -157,7 +156,7 @@ Note that we no longer use the `schema.rb` file (see https://github.com/PecanPro
157156

158157
### Version Numbering
159158

160-
We loosely follow [semantic versioning](http://semver.org/).
159+
We loosely follow [semantic versioning](http://semver.org/){target="_blank"}.
161160

162161
* Any tag of the form betydb\_x.x or betydb\_x.x.x refers to a version that has been tested and deployed.
163162
* Changes in the first or second digit of the version number mark some
@@ -169,8 +168,8 @@ We loosely follow [semantic versioning](http://semver.org/).
169168

170169
Example of a properly commented citation model (
171170
/app/models/citations.rb ):
172-
[https://gist.github.com/e68fea1baa070e68b984](https://gist.github.com/e68fea1baa070e68b984)
171+
[https://gist.github.com/e68fea1baa070e68b984](https://gist.github.com/e68fea1baa070e68b984){target="_blank"}
173172

174173
And a properly commented covariates model ( /app/models/covariates.rb
175174
):
176-
[https://gist.github.com/5d0d96d7be1b1fd7b47c](https://gist.github.com/5d0d96d7be1b1fd7b47c)
175+
[https://gist.github.com/5d0d96d7be1b1fd7b47c](https://gist.github.com/5d0d96d7be1b1fd7b47c){target="_blank"}

0 commit comments

Comments
 (0)