Skip to content

Commit

Permalink
Merge pull request #1 from osg-cat/catworks
Browse files Browse the repository at this point in the history
Tweaks before initial publication
  • Loading branch information
osg-cat authored Feb 22, 2024
2 parents 0630596 + 815c364 commit 983f2ce
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# OSG School 2023
# OSG School 2024

The source files for the OSG School 2023 website.
The source files for the OSG School 2024 website.

To serve the website locally, download Docker and use the command in the root directory:


```console
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```
Expand All @@ -26,9 +25,9 @@ When you add new documentation you should name the file like so: ```part<x>-ex<y

Documentation should be referenced in two locations:

#### [/docs/material/index.md](https://github.com/osg-htc/user-school-2023/blob/main/docs/materials/index.md)
#### [/docs/material/index.md](https://github.com/osg-htc/school-2024/blob/main/docs/materials/index.md)

This is an overview page that contains all documentation and each category's files.
This is an overview page that contains all documentation and each categorys files.

Use format below when adding to this page
```markdown
Expand All @@ -43,7 +42,7 @@ Use format below when adding to this page
- [Exercise 1.2: <exercise-name>](<category>/part1-ex2-<exercise-name>.md)
```
#### [/mkdocs.yml](https://github.com/osg-htc/user-school-2023/blob/main/mkdocs.yml)
#### [/mkdocs.yml](https://github.com/osg-htc/school-2024/blob/main/mkdocs.yml)

This files generates the website navigation. You should not include the category files in this navigation.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ please visit that site to learn about other OSG Outreach activities.

If you have any questions about the event, feel free to email us:

<user-school@opensciencegrid.org>
<school@osg-htc.org>

<a href="https://www.facebook.com/OSGUserSchool" target="_blank" style="border: 0px none black; text-decoration: none;"><img src="files/FB-f-Logo__blue_512.png" height="28" width="28" alt="Facebook logo"></a> <a href="https://twitter.com/OSGUserSchool" target="_blank" style="border: 0px none black; text-decoration: none;"><img src="files/Twitter_logo_blue.png" style="height: 28px; width: 28px; background-color: white;" alt="Twitter logo"></a> OSGUserSchool

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
site_name: OSG School 2024
site_url: https://osg-htc.org/user-school-2023/
site_url: https://osg-htc.org/school-2024/
repo_name: null
theme:
name: material
Expand Down Expand Up @@ -30,4 +30,4 @@ extra:
name: OSG School on Facebook

nav:
- Home: index.md
- Home: index.md

0 comments on commit 983f2ce

Please sign in to comment.