adds instructions so folks can build the website #363
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nsryan2
approved these changes
Feb 1, 2025
| @@ -6,4 +6,26 @@ Fuel Cycles group. | |||
|
|
|||
| ## Building This Website | |||
|
|
|||
| Coming soon... | |||
| It should be sufficient to do the following: | |||
|
|
|||
There was a problem hiding this comment.
Suggested change
| Install the build dependencies for the website. These include ruby, jekyll, and jekyll-scholar. Get started [here](https://jekyllrb.com/docs/installation/). |
| Clone the repo: | ||
| `git clone [email protected]:arfc/arfc.github.io` | ||
|
|
||
| Make your way to the top level of the source branch |
There was a problem hiding this comment.
Suggested change
| Make your way to the top level of the source branch | |
| Make your way to the top level of the source branch: |
| Install the gems: | ||
| `bundle install` | ||
|
|
||
| Build and serve the site locally |
There was a problem hiding this comment.
Suggested change
| Build and serve the site locally | |
| Build and serve the site locally: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
There has not generally been a clear way to build and preview the site on one's own machine. This adds some instructions.
Types of changes
Associated Issues and PRs
This does not solve issue #360, but it was inspired by issue #360.
Checklist for Reviewers
Reviewers should use this link to get to the
Review Checklist before they begin their review.