Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update user install instructions, Add instructions for codespaces #146

Merged
merged 1 commit into from
Jun 21, 2024

Conversation

k-doering-NOAA
Copy link
Member

This pull request:

  • Simplifies the install instructions for users to just user R universe to install (advantage over remotes::install_github - no need to have toolchain installed to build R packages locally, FIMS is precompiled on R universe so install should be quicker).
  • Add instructions for opening a codespace on the FIMS repository. I could not find a link to the GitHub documentation that showed these exact steps, so I think it was necessary to create.

I believe this addresses #122 and #93 ; and partially addresses #98.

@kellijohnson-NOAA
Copy link
Collaborator

If we want to finish #98 we could add the R-universe badge to the NOAA-FIMS/FIMS/README page. Here is the markdown that is needed to include the badge

https://noaa-fims.r-universe.dev/badges/FIMS

@k-doering-NOAA k-doering-NOAA mentioned this pull request Jun 21, 2024
1 task
@k-doering-NOAA
Copy link
Member Author

Thanks @kellijohnson-NOAA , I added NOAA-FIMS/FIMS#636 and made some additional changes here to address #98 fully. The developer installation instructions were moved into the collaborative workflow doc and linked on the FIMS readme. The R universe badge was added on the FIMS readme.

Comment on lines 4 to 7
need to contribute to this project as well as ways FIMS can be installed. This is in addition to the software
dependencies described in the [user installation
guide](#user-installation-guide) which you should ensure are installed
first.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this second sentence "This is in addition to the software ..."

@kellijohnson-NOAA
Copy link
Collaborator

Thanks @k-doering-NOAA for all of the changes. I have a few more comments but I am approving it now.

@k-doering-NOAA
Copy link
Member Author

@kellijohnson-NOAA I tried to address your suggestions! If there is anything else, feel free to modify directly and merge in when you feel it is finished :)

Clearly define user versus developer install instructions and move
developer instructions from NOAA-FIMS/FIMS/README to the collaborative
workflow in the developers section. In exchange for adding how to install
from R-universe on the same readme as these instructions do not require
compiling. Many breadcrumbs were left in the workflow explaining where
users and developers can find relevant information for install and
codespaces.

All work was done by @k-doering-NOAA with suggestions from
@kellijohnson-NOAA and @iantaylor-NOAA.

Close #122
Close #98
Close #93
Close #117
@kellijohnson-NOAA
Copy link
Collaborator

I squashed the commits into one commit and update the commit message to reflect the work done. Once checks pass, I will merge into main.

@kellijohnson-NOAA kellijohnson-NOAA merged commit dcda6b1 into main Jun 21, 2024
1 check passed
@kellijohnson-NOAA kellijohnson-NOAA deleted the codespaces branch June 21, 2024 19:48
kellijohnson-NOAA pushed a commit to NOAA-FIMS/FIMS that referenced this pull request Jun 21, 2024
For users and developers, where the information for the latter was
moved to the collaborative workflow see
NOAA-FIMS/collaborative_workflow#146.

A badge for R-universe was placed in the list of all badges!

Work was done by @k-doering-NOAA with suggestions by @kellijohnson-NOAA

Part of NOAA-FIMS/collaborative_workflow#98
kellijohnson-NOAA pushed a commit to NOAA-FIMS/FIMS that referenced this pull request Jun 21, 2024
For users and developers, where the information for the latter was
moved to the collaborative workflow see
NOAA-FIMS/collaborative_workflow#146.

A badge for R-universe was placed in the list of all badges!

Work was done by @k-doering-NOAA with suggestions by @kellijohnson-NOAA

Part of NOAA-FIMS/collaborative_workflow#98
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants