Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
L
Lesson Template
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
prace-lessons
Lesson Template
Commits
30ed6544
Commit
30ed6544
authored
9 years ago
by
Greg Wilson
Browse files
Options
Downloads
Patches
Plain Diff
Configuration template
parent
25fdcb68
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTING.md
+4
-1
4 additions, 1 deletion
CONTRIBUTING.md
_config_template.yml
+52
-0
52 additions, 0 deletions
_config_template.yml
with
56 additions
and
1 deletion
CONTRIBUTING.md
+
4
−
1
View file @
30ed6544
...
...
@@ -37,7 +37,7 @@ You also agree to abide by our
*
`CONTRIBUTING.md`
: these contribution guidelines.
*
`LICENSE.md`
: license.
*
`Makefile`
: all the commands needed for development.
*
`_config
.yml`
:
general configuration settings
(used on GitHub)
.
*
`_config
_template.yml`
: template for
general configuration settings.
*
`_config_dev.yml`
: configuration overrides for local development.
*
`_episodes`
: source files for teaching episodes (discussed below).
*
`_includes`
: page fragments used in layout.
...
...
@@ -54,6 +54,9 @@ You also agree to abide by our
`_episodes/01-xyz.md`
generates
`/01-xyz/index.html`
,
which can be linked to using
`/01-xyz/`
.
5.
Copy
`_config_template.yml`
to create
`_config.yml`
and then edit the settings in the top half.
## Other Resources
1.
This lesson is based on the template found at
...
...
This diff is collapsed.
Click to expand it.
_config_template.yml
0 → 100644
+
52
−
0
View file @
30ed6544
#------------------------------------------------------------
# Values for this site.
#------------------------------------------------------------
# Domain for searches.
domain
:
"
https://USERNAME.github.io/LESSON-NAME"
# URL for repository.
repo
:
"
https://github.com/USERNAME/LESSON-NAME"
# Root URL for lesson below domain.
root
:
"
/LESSON-NAME"
# Overall lesson title.
title
:
"
Instructor
Training"
# Contact email address.
email
:
USERNAME@SOME.WHERE
#------------------------------------------------------------
# Generic settings (should not need to change).
#------------------------------------------------------------
# Sites.
amy_site
:
"
https://amy.software-carpentry.org/workshops"
dc_site
:
"
https://datacarpentry.org"
swc_github
:
"
https://github.com/swcarpentry"
swc_site
:
"
https://software-carpentry.org"
# Start time in minutes (540 is 09:00 am)
start_time
:
540
# Specify that things in the episodes collection should be output.
collections
:
episodes
:
output
:
true
permalink
:
/:path/
# Set the default layout for things in the episodes collection.
defaults
:
-
scope
:
path
:
"
"
type
:
episodes
values
:
layout
:
episode
# Files and directories that are not to be copied.
exclude
:
-
Makefile
# Turn off built-in syntax highlighting.
highlighter
:
false
This diff is collapsed.
Click to expand it.
Preview
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment