Skip to content

Commit

Permalink
update directory structure requirements (#943)
Browse files Browse the repository at this point in the history
* add link to v 3.1.2

link destination was blank -- added link to take users to version 3.1.2 of docs.

* change subdirectory naming convention

suggest we use `code` instead of `src` for the subdirectory to contain scripts, notebooks, etc as this is a more self-explanatory name for learners who are new to this field if they're poking around in the repo trying to find things. (Not a single one of our modules currently follows this rule anyways, so it will be the same amount of work to bring into compliance either way).

* add data directory convention

* add details about module directory structure

* update QA templates

update QA templates to include up-to-date directory structure standards.

* upversion docs

upversion docs, add old version to previous versions list, remove older versions so only 3 most recent priors are shown.

* Add a checklist for bringing modules up to date with docs v5

---------

Co-authored-by: rosemm <hartmanr1@chop.edu>
Co-authored-by: Rose M. Hartman <rosemm@users.noreply.github.com>
  • Loading branch information
3 people authored Sep 4, 2024
1 parent 93ca00f commit a4f7025
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 10 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_update_checklist_v5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Checklist for updating modules to v5
about: Checklist for updating a module to comply with docs.md v5
title: Docs v5 Update Checklist
assignees: ''

---

# Module Update Checklist
----
Name of Module: {take from the title of the main markdown file for the module}
PR for module update: #[PR number here]

This is the checklist for bringing a module up to date with the latest major version of docs.md: v5

*Note*: There is no checklist to update to v4 because all modules were updated with the v4 change, adding `module_id` to front matter, in the same PR that updated docs.md.
To bring a module at v2 up to date with v5, for example, you only need to use the checklists for v3 and v5.

## Summary of changes

New requirements for directory structure.
Many modules will already follow these conventions, but for those that don't change the subdirectory names and organization to match the new requirements.

## Module directory structure

* [ ] The module content markdown file is the only file on the first level of the directory. All other files are contained within subdirectories.
* [ ] Images, videos, and other audio-visual assets are saved within a `media` folder within the module directory
* [ ] Code files (including scripts, notebooks, etc.) are saved within a `code` folder within the module directory
* [ ] Data files are saved within a `data` folder within the module directory.
* [ ] The only subdirectories that exist are `media`, `code`, and `data`.

## Final check

When you're ready to finalize the updated module, do the following in the module front matter:

* [ ] Increment `version` for the module. This is a revision (although the module content isn't changing at all, the metadata is changing slightly as `docs_version` is updated).
* [ ] Update `docs_version` to 5.0.0
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE/qa-for-exercise-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ assignees: ''
----
Date: {yyyy-mm-dd}
Reviewer: {your name}
qa_template_version: 2.0.2
qa_template_version: 3.0.0
Name of Module: {take from the title of the main markdown in the PR}
Current Liascript URL: {makes it easy for reviewers and authors to look at content as learners will}

Expand All @@ -20,7 +20,11 @@ Current Liascript URL: {makes it easy for reviewers and authors to look at conte
## Directory structure
* [ ] Folder and file names use lowercase and underscores (no dashes)
* [ ] Main module directory folder name is identical to the name of the module content markdown file.
* [ ] The module content markdown file is the only file on the first level of the directory. All other files are contained within subdirectories.
* [ ] Images, videos, and other audio-visual assets are saved within a `media` folder within the module directory
* [ ] Code files (including scripts, notebooks, etc.) are saved within a `code` folder within the module directory
* [ ] Data files are saved within a `data` folder within the module directory.
* [ ] The only subdirectories that exist are `media`, `code`, and `data`.

## Module Organization
* [ ] Front matter is at the very top of the file
Expand Down
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE/qa-for-standard-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ assignees: ''
----
Date: {yyyy-mm-dd}
Reviewer: {your name}
qa_template_version: 2.0.2
qa_template_version: 3.0.0
Name of Module: {take from the title of the main markdown in the PR}
Current Liascript URL: {makes it easy for reviewers and authors to look at content as learners will}

Expand All @@ -20,7 +20,11 @@ Current Liascript URL: {makes it easy for reviewers and authors to look at conte
## Directory structure
* [ ] Folder and file names use lowercase and underscores (no dashes)
* [ ] Main module directory folder name is identical to the name of the module content markdown file.
* [ ] The module content markdown file is the only file on the first level of the directory. All other files are contained within subdirectories.
* [ ] Images, videos, and other audio-visual assets are saved within a `media` folder within the module directory
* [ ] Code files (including scripts, notebooks, etc.) are saved within a `code` folder within the module directory
* [ ] Data files are saved within a `data` folder within the module directory.
* [ ] The only subdirectories that exist are `media`, `code`, and `data`.

## Module Organization
* [ ] Front matter is at the very top of the file
Expand Down
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE/qa-for-wrapper-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ assignees: ''
----
Date: {yyyy-mm-dd}
Reviewer: {your name}
qa_template_version: 2.0.2
qa_template_version: 3.0.0
Name of Module: {take from the title of the main markdown in the PR}
Current Liascript URL: {makes it easy for reviewers and authors to look at content as learners will}

Expand All @@ -20,7 +20,11 @@ Current Liascript URL: {makes it easy for reviewers and authors to look at conte
## Directory structure
* [ ] Folder and file names use lowercase and underscores (no dashes)
* [ ] Main module directory folder name is identical to the name of the module content markdown file.
* [ ] The module content markdown file is the only file on the first level of the directory. All other files are contained within subdirectories.
* [ ] Images, videos, and other audio-visual assets are saved within a `media` folder within the module directory
* [ ] Code files (including scripts, notebooks, etc.) are saved within a `code` folder within the module directory
* [ ] Data files are saved within a `data` folder within the module directory.
* [ ] The only subdirectories that exist are `media`, `code`, and `data`.

## Module Organization
* [ ] Front matter is at the very top of the file
Expand Down
15 changes: 8 additions & 7 deletions docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
author: DART Team
email: dart@chop.edu
version: 4.0.4
current_version_description: Added module\_id as required frontmatter field for all modules; make liascript link(s) point to first page; move standard learning_objectives language to macro;
version: 5.0.0
current_version_description: Update module directory requirements
language: en
narrator: UK English Female
title: DART LiaScript docs
Expand All @@ -25,10 +25,9 @@ try {
@version_history
Previous versions:
- [3.1.2](): Updated definition of learn\_to\_code collection
- [4.0.3](https://liascript.github.io/course/?https://raw.githubusercontent.com/arcus/education_modules/d367a7d5a0e9b6abdf67883b31d4a8894a13b17a/docs.md): Added module\_id as required frontmatter field for all modules; make liascript link(s) point to first page; move standard learning_objectives language to macro;
- [3.1.2](https://liascript.github.io/course/?https://raw.githubusercontent.com/arcus/education_modules/d4409612159096b9f3bebfc2f7ddf795b92496cd/docs.md#1): Updated definition of learn\_to\_code collection
- [3.0.0](https://liascript.github.io/course/?https://raw.githubusercontent.com/arcus/education_modules/cd0da90a30910c22d5502f509125892a761c3145/docs.md#1): Added collection as a front matter field, added text as a data\_domain, fixed typos
- [2.0.0](https://liascript.github.io/course/?https://raw.githubusercontent.com/arcus/education_modules/89cadafc6f1f9c83e4de93e7d55cd9427866f9f2/docs.md#1): Made coding\_required a mandatory front matter field for all modules
- [1.3.1](https://liascript.github.io/course/?https://raw.githubusercontent.com/arcus/education_modules/b453a05b5ac756fb5c7b183deae9d4fc91b3a617/docs.md#1): Clarified that version\_history cannot be blank but sets\_you\_up\_for and depends\_on\_knowledge\_available\_in can
@end
import: https://raw.githubusercontent.com/arcus/education_modules/main/_module_templates/macros.md
Expand Down Expand Up @@ -94,8 +93,10 @@ You can also see revisions and comments on [pull requests for other modules that

* Folder and file names use lowercase and underscores (no dashes)
* Main module directory folder name is identical to the name of the module content markdown file (this name is called the [module\_id](#module_id)).
* Images, videos, and other audio-visual assets are saved within a `media` folder within the module directory
* Code files (including scripts, notebooks, etc.) are saved within a `src` folder within the module directory
* The module markdown file should be the only file on the first level of the module directory. All other files should be contained in one of the following folders. If you come across a need to include a file that does not neatly fit into one of these categories, [submit an issue](https://github.com/arcus/education_modules/issues/new) so we can create a new category if necessary:
* Images, videos, and other audio-visual assets are saved within a `media` folder within the module directory
* Code files (including scripts, notebooks, etc.) are saved within a `code` folder within the module directory
* Data files are saved within a `data` folder within the module directory.

<div class = "important">
<b style="color: rgb(var(--color-highlight));">Important note</b><br>
Expand Down

0 comments on commit a4f7025

Please sign in to comment.