Skip to content

Commit

Permalink
#16: Update publishing-to-rtc.md
Browse files Browse the repository at this point in the history
  • Loading branch information
njr2128 authored Apr 25, 2024
1 parent ac19dca commit 93eed33
Showing 1 changed file with 38 additions and 14 deletions.
52 changes: 38 additions & 14 deletions how-tos/publishing-to-rtc.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,18 @@ In sum:

## Naming spec for files and pages

`[type]_[semester+year]_[lastname]_[firstname]_[subject or title or short description]`
`[type]_[semester+year]_[lastname]_[firstname]_[subject or title or short description].[file extension]`

delimited `-` within each field

If a file does not have one of these values (e.g., there is no "name" associated with it), simply omit that segment.
*File extensions*
- If you are working on a webpage, make sure the file extension is `.md`
- If you are working on a downloadable resource, make sure the file extension is correct for the type of file (e.g., `.pdf`, `.pptx`, `.xlsx`, etc)

If a file does not have one of these values (e.g., there is no "name" associated with it), simply omit that segment.

You can use the original name of the document in the title segment, but sanitize it to meet the requirements described in [Naming Protocols](naming-protocols.md#guidelines) and pre-pend type and date and name information (if decipherable).


### `[type]` values:
1. `syllabus`
Expand All @@ -55,9 +62,6 @@ e.g., "fa17" for fall 2017, or "sp16" for spring 2016, or "su21" for summer 2021
### Examples by type
Follow the basic protocols described in [Naming Protocols](naming-protocols.md#guidelines).

- If you are working on a webpage, make sure the file extension is `.md`
- If you are working on a downloadable resource, make sure the file extension is correct for the type of file (e.g., `.pdf`, `.pptx`, `.xlsx`, etc)

#### 1. Syllabus

`syllabus_[date]_[lastname]_[firstname]_[brief title which can include course number and short name of course].[file extension]`
Expand All @@ -72,21 +76,46 @@ e.g., `casestudy_sp22_nielson_christina_arth-295-ingenious-making.md`

#### 3. Activitysheet

Webpage: `activitysheet_[date]_[lastname]_[firstname]_[brief title which can include course number and short name of course].[file extension]`
Webpage: `activitysheet_[date]_[lastname]_[firstname]_[brief title or desription of activity].[file extension]`

e.g., `activity_sp22_azurite-preparation.md`

/[--NJR IN THE MIDDLE HERE---/]
#### 4. Project

Webpage: `project_[date]_[lastname]_[firstname]_[brief title or keywords].[file extension]`

e.g., `activity_sp22_nebolsin_victoria_animal-rationality.md`

#### 5. Reflection

Webpage: `reflection_[date]_[lastname]_[firstname]_[brief title or description].[file extension]`

e.g., `reflection_smith_pamela_reconstruction-insights.md`

#### 6. Digital

Webpage: `digital_[date]_[lastname]_[firstname]_[brief title or description].[file extension]`

e.g., `digital_rosenkranz_naomi_entry-categories.md`

### Naming protocol for static documents:
`[type]_[date]_[name]_[brief title which can include course number and short name of course].md`

e.g., `casestudy_sp22_nielson_arth-295-ingenious-making.docx`

You can use the original name of the document in the title segment, but sanitize it to meet the requirements described in [Naming Protocols](naming-protocols.md#guidelines) and pre-pend type and date and name information (if decipherable).

**Webpages (anything that lives in `/content/`)**
## Including external URLs
Whenever we include links to external resources, we need to consider whether those URLs and resources meet our plans for digital sustainability.
- If possible, use a persistent identifier such as a DOI or "permanent URL."
- If possible, if the resource is also stored in a digital repository (e.g., Academic Commons, JSTOR, Internet Archive), cite that location for the resource.
- If you are citing a webpage that is not a formal pulication (such as a blog), look for a version in Internet Archive and include that link in addition to the original (e.g., but adding "archived at [link]). If there is no version available there, use the service provided by Internet Archive and the Wayback Machine to create an archivable link: [Save Pages in the Wayback Machine](https://help.archive.org/help/save-pages-in-the-wayback-machine/).






< -- WE NEED TO WORK ON THIS -- >
## Images
Images to be used in the website should be uploaded to `/static/images/`. Note: Hugo will place this directory at the root of the website, e.g., `teaching640.makingandknowing.org/images`.

Expand All @@ -102,11 +131,6 @@ e.g., `howtouse-del.png`
e.g., `about-sponsors-NSF.png`


## Including external URLs
Whenever we include links to external resources, we need to consider whether those URLs and resources meet our plans for digital sustainability.
- If possible, use a persistent identifier such as a DOI or "permanent URL."
- If possible, if the resource is also stored in a digital repository (e.g., Academic Commons, JSTOR, Internet Archive), cite that location for the resource.
- If you are citing a webpage that is not a formal pulication (such as a blog), look for a version in Internet Archive and include that link in addition to the original (e.g., but adding "archived at [link]). If there is no version available there, use the service provided by Internet Archive and the Wayback Machine to create an archivable link: [Save Pages in the Wayback Machine](https://help.archive.org/help/save-pages-in-the-wayback-machine/).



0 comments on commit 93eed33

Please sign in to comment.