Skip to content

Commit

Permalink
Initial Commit
Browse files Browse the repository at this point in the history
  • Loading branch information
CannonLock committed Jan 3, 2025
0 parents commit 8569f5d
Show file tree
Hide file tree
Showing 12 changed files with 680 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/deploy-mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Deploy static MkDocs pages
on:
push:
branches: [ main ]

jobs:
deploy-mkdocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Deploy MkDocs pages
if: startsWith(github.repository, 'osg-htc/')
uses: docker://squidfunk/mkdocs-material:7.1.0
with:
args: >-
gh-deploy
--verbose
396 changes: 396 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

78 changes: 78 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# OSG User School 2023

The source files for the OSG User School 2023 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
```

ARM
```shell
docker run --rm -it -p 8100:8000 -v ${PWD}:/docs ghcr.io/afritzler/mkdocs-material
```

# Adding Documentation to the Website

## Adding in the Documentation

Documentation is hosted in the ```/docs/material``` directory.

Each category of documentation is in a subdirectory at location ```/docs/material/<category>```.

When you add new documentation you should name the file like so: ```part<x>-ex<y>-<name>.md```

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)

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

Use format below when adding to this page
```markdown
## <category>

([PDF](<category>/files/<filename>.pdf),
[PowerPoint](<category>/files/<filename>.pptx))

### <category> Exercises:

- [Exercise 1.1: <exercise-name>](<category>/part1-ex1-<exercise-name>.md)
- [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)

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

If you are adding materials it will look like so:
```yaml
nav:
- Materials:
- <Category0> Exercises:
- Exercise 1.1: materials/<category0>/part1-ex1-<exercise-name>.md
- Exercise 1.2: materials/<category0>/part1-ex2-<exercise-name>.md
- <Category1> Exercises:
- Exercise 1.1: materials/<category1>/part1-ex1-<exercise-name>.md
- Exercise 1.2: materials/<category1>/part1-ex2-<exercise-name>.md
```
**Note:** This is generated in order so the order of the categories should correspond to the material overview page.
## Adding in Additional Files
Files corresponding to each category should be in the subdirectory at location ```/docs/material/<category>/files/```.

Additionally all files should be referenced in the ```/docs/material/index.md``` file using format:
```markdown
```markdown
## <category>

([PDF](<category>/files/<filename>.pdf),
[PowerPoint](<category>/files/<filename>.pptx))

### <category> Exercises:
- ...
```
Binary file added docs/assets/Madison_Skyline.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/OSG_Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/assets/OSG_Logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/files/FB-f-Logo__blue_512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/files/Twitter_logo_blue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# OSG User School 2023

<figure>
<img src="assets/Madison_Skyline.jpeg" alt="Madison Skyline" />
</figure>

<p style="font-size: larger; font-weight: bold;">Could you transform your research with vast amounts of computing?</p>

*Learn how during a week this summer at the lovely [University of Wisconsin–Madison](https://wisc.edu/)*

During the School,
you will learn to use [high-throughput computing](https://htcondor.org/htc.html) (HTC) systems —
at your own campus or using the national-scale [OSG](https://osg-htc.org/)
to run large-scale computing applications that are at the heart of today’s cutting-edge science.

Through lectures, discussions, and **lots of hands-on activities** with experienced OSG staff,
you will learn how HTC systems work,
how to run and manage lots of jobs and huge datasets to implement a scientific computing workflow,
and where to turn for more information and help.

The school is ideal for graduate students in any research area
for which large-scale computing is a vital part of the research process,
plus we welcome applications from advanced undergraduates, post-doctoral students, faculty, and staff
(especially staff who perform research or support/facilitate researchers).

People accepted to this program will receive financial support for
basic travel and local costs associated with the School.


## Contact Us

The OSG User School is part of the
[OSG Outreach Area](https://osg-htc.org/outreach/)&nbsp;&mdash;
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>

<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

<p style="font-size: 90%;">* Image provided by Wikimedia user Av9 under <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en">Creative Commons License</a></p>

7 changes: 7 additions & 0 deletions docs/stylesheets/code-highlight.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
span.hll {
background-color: rgba(255,255,0,.5)
}

button.md-clipboard.md-icon {
display: none;
}
89 changes: 89 additions & 0 deletions docs/stylesheets/osg.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
:root {
--md-default-fg-color: #3a3a3a;
--md-primary-fg-color: #F1A52C;
--md-primary-bg-color: #3a3a3a;
--md-accent-fg-color: #FFC364;
}

:root>* {
--md-footer-bg-color: #3a3a3a;

--md-typeset-a-color: #ad510c;
--md-text-font-family: "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif;
}

.md-typeset h1, .md-typeset h2 {
font-weight: 400;
}

.md-typeset__table td {
padding-top: 5px !important;
padding-bottom: 5px !important;
}

.md-typeset table th {
min-width: 0px !important;
}

.before-dot::before {
content: '';
display: inline-block;
width: 13px;
height: 13px;
margin-right: 5px;
-moz-border-radius: 6.5px;
-webkit-border-radius: 6.5px;
border-radius: 6.5px;
transform: translate(0%,15%);
}

.text-light-blue::before {
background-color: #648fff
}

.text-blue::before {
background-color: #785ef0;
}

.text-pink::before {
background-color: #dc267f;
}

.text-orange::before {
background-color: #fe6100;
}

.text-light-orange::before {
background-color: #ffb000;
}

.text-black::before {
background-color: #000;
}

.tabbed-in {
margin-left: 18px;
}

/*$text: #3a3a3a;*/
/*$primary: */
/*$secondary: #F1A52C;*/
/*$info: #FFC364;*/
/*$warning: #fff1c7;*/
/*$white-offset: #fff7ea;*/
/*$nav-link-color: $text;*/


/*$nav-link-font-weight: 500;*/
/*$navbar-light-color: #3a3a3a;*/

/*$border-radius: 1rem;*/

/*$btn-border-radius: .25rem;*/

/*$card-border-color: black;*/
/*$card-border-radius: $border-radius;*/

/*$font-family-base: "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif;*/
/*$headings-font-family: "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif;*/
/*$headings-font-weight: 600;*/
33 changes: 33 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
site_name: OSG User School 2023
site_url: https://osg-htc.org/user-school-2023/
repo_name: null
theme:
name: material
logo: assets/OSG_Logo.svg
favicon: assets/OSG_Logo.png

markdown_extensions:
- attr_list
- admonition
- codehilite:
guess_lang: False
- meta
- pymdownx.details
- toc:
permalink: True

extra_css:
- stylesheets/code-highlight.css
- stylesheets/osg.css

extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/OSGUserSchool
name: OSG User School on Twitter
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/OSGUserSchool
name: OSG User School on Facebook

nav:
- Home: index.md

0 comments on commit 8569f5d

Please sign in to comment.