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

[ENH] Datalad documentation, archiving The Way, updating information on Jekyll versions for GH page building #80

Merged
merged 30 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from 26 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .jekyll-metadata
Binary file not shown.
Empty file added 3.0.8
Empty file.
4 changes: 4 additions & 0 deletions assets/images/datalad.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 9 additions & 3 deletions docs/Contributing/documentation_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,26 +122,32 @@ Next, make sure you have `Ruby` installed; the best way to check this is to do `
To install ruby, just do:

```
brew install ruby
brew install ruby@3.2
kahinimehta marked this conversation as resolved.
Show resolved Hide resolved

# YOU SHOULD PROBABLY ALSO ADD IT TO YOUR PATH LIKE SO:

echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.bash_profile
export PATH="/Users/~/.gem/ruby/2.6.0/bin:$PATH"

```

Now install `jekyll` using a ruby "gem", by doing the following:

```
# PERMISSIONS MAY BE REQUIRED

gem install --user-install bundler -v 2.4.22
gem install --user-install bundler jekyll
```
Note that the version may change and you may need to install/update some dependencies using the same format! You can use `sudo` for permissions errors.

In this last step, you instruct `jekyll` to take all of the templates and files in the current directory and spin them up into a webpage, and `ruby` will serve it on your local machine. The instruction for this, from the root directory of the repo:

```
cd PennLINC.github.io
bundle exec jekyll serve
bundle install
bundle _2.1.4_ exec jekyll serve
```
Note that this is the version (2.1.4) that works for me at this moment. This may change!

If you see something like this:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: default
title: Available Static Datasets
parent: Data Tasks
nav_order: 2
parent: Data Workflows
nav_order: 4
has_toc: false
---

Expand Down
Loading