-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update directory structure requirements (#943)
* 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
1 parent
93ca00f
commit a4f7025
Showing
5 changed files
with
60 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters