-
Notifications
You must be signed in to change notification settings - Fork 1
Developer Notes
Use the semantic versioning system for numbering releases and follow the "v.X.Y.Z" format. Updating the version will update the compiled package files that users can download and run location installations of FishSET.
Follow the steps below to re-deploy the FishSET website:
a. Set git branch to 'master' in R Studio, and run pkgdown::deploy_to_branch() in the console. Leave inputs for the function blank. This process can take a few minutes, and you may get a couple warning messages. Just check that the 'gh-pages' branch is updated and passes github action checks.
b. Change branch to 'gh-pages'.
c. Add the files "FishSET_User_Manual.html" and "FishSET_User_Manual.pdf" to the articles folder (files located in the Google 'FishSET Team Folder' > 'GitHub' folder. Check that the version number in the .html file is current.
d. In each of the .html files in the articles folder, insert:
<a class="dropdown-item" href="../articles/FishSET_User_Manual.html">FishSET User Manual</a>
Insert the line just above the "FishSET R Package functions" dropdown-item code (about line 50 in the files; line 25 in the index.html file). This can be done by opening the .html files in R. However, the 'scallop-example.hmtl' file is too large to open in R but can be modified in a text editor (e.g., Notepad).
e. In the 'reference' folder, find the 'index.html' file and insert the line of code above for the user manual dropdown item (about line 25 in the index file).
f. In the 'gh-pages' branch, there is another 'index.html' file in the main folder. Locate the file and insert the line:
<a class="dropdown-item" href="articles/FishSET_User_Manual.html">FishSET User Manual</a>
g. In the 'pkgdown.yml' file, add a line for the FishSET User Manual above the function list:
FishSET_User_Manual: FishSET_User_Manual.html
h. Push these changes to the remote 'gh-pages' branch. Check that the website was updated.