Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Courses
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
6
Issues
6
List
Board
Labels
Milestones
Merge Requests
4
Merge Requests
4
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
M3P2
Courses
Commits
d71913f1
Commit
d71913f1
authored
Mar 16, 2019
by
Goutte
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add other suggestions of file paths implementation
So far, v3 is my favorite.
parent
990d2a44
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
43 additions
and
7 deletions
+43
-7
SPECIFICATIONS.md
SPECIFICATIONS.md
+43
-7
No files found.
SPECIFICATIONS.md
View file @
d71913f1
...
...
@@ -6,13 +6,7 @@
## Files Paths
```
<topic>[/<topic>]/chapter<NN>-<type>.<language>.<format>
or
<topic>[/<topic>]/<NN>-<title>-<type>.<language>.<format>
or
???
```
Let:
-
`topic`
: lowercase alphanumeric topic name (in english, sorry)
-
`NN`
: level of the course, an integer with always two digits
...
...
@@ -21,11 +15,53 @@ or
-
`textbook`
-
`cheatsheet`
(?)
-
`annex`
-
`exercises`
-
`language`
: 2 letter lowercase language code
-
`format`
:
`md`
for markdown
Let's review our options, now.
## Files Paths v1
```
<topic>[/<topic>]/chapter<NN>-<type>.<language>.<format>
or
<topic>[/<topic>]/<NN>-<title>-<type>.<language>.<format>
or
???
```
## Files Paths v2
```
<N>.<topic>[/<M>.<topic>]/<K>.<slug>/<type>.<language>.<format>
```
Each chapter gets its own directory, which will be simpler for assets organization.
`01.optics/03.the-nature-of-light/textbook.fr.md`
## Files Paths v3
`en/01.optics/03.the-nature-of-light/textbook.md`
`fr/01.optique/03.la-nature-de-la-lumiere/cahier.md`
Pros:
-
Everything
Cons:
-
Will rely on Ids, so changing them afterwards is fastidious
-> Can be mitigated by initially generating an empty topic dir structure
-----
## Courses Model
Each Course MUST have:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment