Skip to content

Commit 7000e5a

Browse files
committed
minor typo fixes
1 parent e012a7c commit 7000e5a

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

contribution_guide.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,22 +98,24 @@ is the a URL-encoded form of the latex commands to generate the equation. Here a
9898

9999
## Adding a Hands On Example
100100

101+
1. Be sure to start from the [lesson template](lessons/lesson_template/lesson.md)
101102
1. Add a new directory to `./lessons/<new-example-name>`
102103
1. Add a new line to `./lessons/lessons.md` for the new example
103-
1. Copy `./lessons/lesson_template/lesson.md` to `./lessons/<new-example-name>`.
104+
1. Copy the [lesson template](lessons/lesson_template/lesson.md), `./lessons/lesson_template/lesson.md` to `./lessons/<new-example-name>`.
104105
1. Edit/revise the copied `lesson.md` file to create the new lesson
105106
1. You can link to images, source code files that you place in `./lessons/<new-example-name>`
106107
using standard Markdown links.
107108

108-
I think it would be best put all content related to each hands-on example we develop here
109+
I think it would be best put all content related to each hands-on lesson we develop here
109110
into its own separate directory. That means all images, example codes, markdown pages, etc.
110111
Then, we can have a separate page (or page hierarchy) that indexes the examples.
111112

112113
I know Jekyll has a built-in concept of a `posts` object. That is because Jekyll is designed
113114
around the notion of supporting blogging. It may make sense to handle each hands-on kinda
114115
sorta like a `post` in Jekyll. But, I think that also means that content related to each
115116
lesson gets scattered across multiple directories (at least given the **default**) way that
116-
Jekyll seems to handle `posts`.
117+
Jekyll seems to handle `posts`. We need to investigate proper use of Jekyll further **after**
118+
we've completed ATPESC.
117119

118120
## GitHub Style Primer
119121

lessons/superlu-mfem/lesson.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ domain where it is 1.0.
4141

4242
Solving this PDE is well known to cause convergence problems for iterative solvers,
4343
for larger _v_. We use MFEM as a vehicle to demonstrate the use of a distributed,
44-
direct solver to solve very ill-conditioned linear systems.
45-
parallel [SuperLU_DIST](http://crd-legacy.lbl.gov/~xiaoye/SuperLU/)
44+
direct solver, [SuperLU_DIST](http://crd-legacy.lbl.gov/~xiaoye/SuperLU/),
45+
to solve very ill-conditioned linear systems.
4646

4747
## The Example Source Code
4848

0 commit comments

Comments
 (0)