Add course structure

Signed-off-by: guillemdb <[email protected]>
FragileTech · Feb 19, 2021 · f1d4423 · f1d4423
1 parent d0a6740
commit f1d4423
Show file tree

Hide file tree

Showing 15 changed files with 70 additions and 15 deletions.
diff --git a/.gitignore b/.gitignore
@@ -28,7 +28,7 @@ share/python-wheels/
 MANIFEST
 
 # PyInstaller
-#  Usually these files are written by a python script from a template
+#  Usually these files are written by a python script from a course
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec

diff --git a/README.md b/README.md
@@ -6,9 +6,35 @@ across the company.
 All the documentation will be written in [Markdown](https://www.markdownguide.org/), and updated
 following our [Git workflow](guide/git_flow/git-flow.md).
 
-## Resources for learning Markdown
 
-* [Markdown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
-* [Another markdown cheat sheet](https://www.markdownguide.org/cheat-sheet)
-* [ProWritingAid](https://prowritingaid.com/) A grammar checker, style editor, 
-  and writing mentor. You can use it to improve your writing skills.
+## Next steps
+
+* Fragile Guide project
+    - Guide structure
+    - PR & Issues template
+    - Scheduling pair programming sessions
+
+* Add organization guide
+    - Communication protocols and tools
+    - Planning and strategy process
+    - Roadmap
+    - Value framework
+    - Business strategy
+
+* Add markdown tutorial
+    - Add style guide.
+    - Add quick reference for the different features.
+    - Explain different features on docs/GitHub.
+
+* Improve git guide
+    - Add remaining material for PRs.
+    - Add tutorial about rewriting the Git history.
+    - Add links between sections and example images.
+    - Complete FAQ.dm.
+    - Improve how-to.md.
+    - Add why PRs are important.
+
+* Add Ubuntu section
+    - Add Bash tutorial
+    - Add common tools overview
+    - Add configuration tutorial
diff --git a/template/4_FAQ.md → course/FAQ.md b/template/4_FAQ.md → course/FAQ.md
diff --git a/course/assets/course_structure.dia b/course/assets/course_structure.dia
diff --git a/course/assets/course_structure.png b/course/assets/course_structure.png
diff --git a/template/6_bibliography.md → course/bibliography.md b/template/6_bibliography.md → course/bibliography.md
diff --git a/template/5_debugging.md → course/debugging.md b/template/5_debugging.md → course/debugging.md
diff --git a/template/3_how_to.md → course/how_to.md b/template/3_how_to.md → course/how_to.md
diff --git a/course/index.md b/course/index.md
@@ -0,0 +1,15 @@
+# Fragile Course
+
+You can use the Company Guide to learn how to improve your productivity on your own projects. This
+section organizes the contents of the Guide proposing a timeline to learn about the different topics.
+
+The course is divided on 7 different blocks covering all the different areas of AI research.
+
+:::{figure-md} git-flow
+:width: 400px
+:align: center
+
+![Git workflow](assets/course_structure.png)
+
+Course structure
+:::
diff --git a/template/1_overview.md → course/overview.md b/template/1_overview.md → course/overview.md
diff --git a/template/2_topic.md → course/topic_documents.md b/template/2_topic.md → course/topic_documents.md
diff --git a/guide/python/markdown_style_guide.md b/guide/python/markdown_style_guide.md
@@ -0,0 +1,12 @@
+## Resources for learning Markdown
+
+### Standard Markdown
+* [Markdown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
+* [Another markdown cheat sheet](https://www.markdownguide.org/cheat-sheet)
+* [ProWritingAid](https://prowritingaid.com/) A grammar checker, style editor, 
+  and writing mentor. You can use it to improve your writing skills.
+
+### Writing Markdown in GitHub comments
+
+### Writing Markdown in Documentation
+* [myst_parser](https://myst-parser.readthedocs.io)
diff --git a/sphinx/source/conf.py b/sphinx/source/conf.py
@@ -34,10 +34,10 @@ def symlink_guide():
         run(f"rm -rf {source_dir.parent / 'build'}")
     if (source_dir / "guide").exists():
         run(f"rm -rf {source_dir / 'guide'}")
-    if (source_dir / "template").exists():
-        run(f"rm -rf {source_dir / 'template'}")
+    if (source_dir / "course").exists():
+        run(f"rm -rf {source_dir / 'course'}")
     run(f"ln -sr {source_dir.parent.parent / 'guide'} {source_dir}")
-    run(f"ln -sr {source_dir.parent.parent / 'template'} {source_dir}")
+    run(f"ln -sr {source_dir.parent.parent / 'course'} {source_dir}")
 
 
 symlink_guide()

diff --git a/sphinx/source/course b/sphinx/source/course
@@ -0,0 +1 @@
+../../course
diff --git a/sphinx/source/index.md b/sphinx/source/index.md
@@ -11,12 +11,13 @@
 maxdepth: 5
 caption: Guide template
 ---
-template/1_overview.md
-template/2_topic.md
-template/3_how_to.md
-template/4_FAQ.md
-template/5_debugging.md
-template/6_bibliography.md
+course/index.md
+course/overview.md
+course/topic.md
+course/how_to.md
+course/FAQ.md
+course/debugging.md
+course/bibliography.md
 ```
 
 {ref}`search`