diff --git a/assets/img/website-guide/add-lesson/step1.png b/assets/img/website-guide/add-lesson/step1.png new file mode 100644 index 0000000..5030df2 Binary files /dev/null and b/assets/img/website-guide/add-lesson/step1.png differ diff --git a/assets/img/website-guide/add-lesson/step2.png b/assets/img/website-guide/add-lesson/step2.png new file mode 100644 index 0000000..2701678 Binary files /dev/null and b/assets/img/website-guide/add-lesson/step2.png differ diff --git a/assets/img/website-guide/add-lesson/step3.png b/assets/img/website-guide/add-lesson/step3.png new file mode 100644 index 0000000..52e8b9f Binary files /dev/null and b/assets/img/website-guide/add-lesson/step3.png differ diff --git a/assets/img/website-guide/add-lesson/step4.png b/assets/img/website-guide/add-lesson/step4.png new file mode 100644 index 0000000..263cd64 Binary files /dev/null and b/assets/img/website-guide/add-lesson/step4.png differ diff --git a/assets/img/website-guide/timeline-1.png b/assets/img/website-guide/timeline-1.png new file mode 100644 index 0000000..5fe8dec Binary files /dev/null and b/assets/img/website-guide/timeline-1.png differ diff --git a/assets/img/website-guide/timeline-2.png b/assets/img/website-guide/timeline-2.png new file mode 100644 index 0000000..75445cf Binary files /dev/null and b/assets/img/website-guide/timeline-2.png differ diff --git a/assets/img/website-guide/timeline-3.png b/assets/img/website-guide/timeline-3.png new file mode 100644 index 0000000..a7abff7 Binary files /dev/null and b/assets/img/website-guide/timeline-3.png differ diff --git a/assets/img/website-guide/timeline-4.png b/assets/img/website-guide/timeline-4.png new file mode 100644 index 0000000..244810b Binary files /dev/null and b/assets/img/website-guide/timeline-4.png differ diff --git a/docs/imls-website-guide/add-lesson.md b/docs/imls-website-guide/add-lesson.md new file mode 100644 index 0000000..2c31ade --- /dev/null +++ b/docs/imls-website-guide/add-lesson.md @@ -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`**\ +step1 + +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:\ +step2 + +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\ + step3 + +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! + step3 + +5. **Congrats! You just added a new lesson to the table. 🎉👏👏👏** diff --git a/docs/imls-website-guide/timeline.md b/docs/imls-website-guide/timeline.md index b0f11df..cc3183e 100644 --- a/docs/imls-website-guide/timeline.md +++ b/docs/imls-website-guide/timeline.md @@ -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) \ No newline at end of file