generated from just-the-docs/just-the-docs-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from ucla-imls-open-sci/imls-website-guide
Imls website guide
- Loading branch information
Showing
10 changed files
with
63 additions
and
2 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: Add Lesson | ||
layout: default | ||
parent: IMLS Website Guide | ||
nav_order: 4 | ||
--- | ||
|
||
# Adding a Lesson Entry | ||
1. **In the [IMLS Repository](https://github.com/ucla-imls-open-sci/ucla-imls-open-sci.github.io) (or it can be a local repository) navigate to `_data/sitetext.yml`**\ | ||
<img src="{{ site.baseurl }}/assets/img/website-guide/add-lesson/step1.png" alt="step1" width="400"/> | ||
|
||
2. **Under the `lessontab` section, add the following lines:** | ||
``` | ||
- lesson-title: | ||
site: | ||
repo: | ||
notes: | ||
status: | ||
author: | ||
``` | ||
- Make sure the indentation is correct! | ||
- It should look like this:\ | ||
<img src="{{ site.baseurl }}/assets/img/website-guide/add-lesson/step2.png" alt="step2" width="600"/> | ||
|
||
3. **Add content to your lesson** | ||
- `lesson-title`: Title of the lesson | ||
- `site`: Link to the lesson site | ||
- `repo`: Link to the repository of the lesson site | ||
- `notes`: Link to the notes page of the lesson site | ||
- `status`: Status of the lesson (pre-alpha, alpha, beta, or stable) | ||
- `author`: author(s) of the lesson\ | ||
<img src="{{ site.baseurl }}/assets/img/website-guide/add-lesson/step3.png" alt="step3" width="600"/> | ||
|
||
4. **After you push the changes to the main branch, you should see the new lesson entry in the table.**\ | ||
- Make sure to click on each of the links to check that it's linked to a correct website! | ||
<img src="{{ site.baseurl }}/assets/img/website-guide/add-lesson/step4.png" alt="step3" width="800"/> | ||
|
||
5. **Congrats! You just added a new lesson to the table. ππππ** |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,30 @@ | ||
--- | ||
title: Add tab | ||
title: Timeline | ||
layout: default | ||
parent: IMLS Website Guide | ||
nav_order: 4 | ||
nav_order: 5 | ||
--- | ||
|
||
# Changing the Timeline | ||
|
||
1. **In the [IMLS Repository](https://github.com/ucla-imls-open-sci/ucla-imls-open-sci.github.io) navigate to `_data/sitetext.yml`** | ||
|
||
![_data/sitetext.yml]({{ site.baseurl }}/assets/img/website-guide/timeline-1.png) | ||
|
||
2. **Find the "timeline" section** | ||
|
||
You can do this with `ctrl/cmd + f timeline` | ||
![timeline section]({{ site.baseurl }}/assets/img/website-guide/timeline-2.png) | ||
|
||
3. **Add or Remove a Timeline** | ||
You can do so by copying a timeline object and altering the fields | ||
1. `title:` Title of the new event/object | ||
2. `year:` The time-dates of the event/object | ||
3. `desc:` A description of the event/object | ||
4. `image:` A reference to the image you want to display | ||
5. `alt:` An alternative for the image in case it doesn't load | ||
|
||
![Add Timeline]({{ site.baseurl }}/assets/img/website-guide/timeline-3.png) | ||
|
||
4. **After you push the changes to the main branch, you should see the new timeline entry in the list.** | ||
![Timeline Webpage]({{ site.baseurl }}/assets/img/website-guide/timeline-4.png) |