Organize docs directory (#988)

* Organize docs directory * Migrate user_guide into docs folder
sillsdev · Feb 5, 2021 · 68f6c5e · 68f6c5e
1 parent 88d4572
commit 68f6c5e
Show file tree

Hide file tree

Showing 36 changed files with 16 additions and 16 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -5,12 +5,12 @@
 !nginx
 !public
 !src
-!user_guide
+!docs/user_guide
 !.env
 !dev-requirements.txt
 !package*.json
 !tsconfig.json
 !tox.ini
 
 # Ignore user guide build directory.
-user_guide/site
+docs/user_guide/site
diff --git a/.gitignore b/.gitignore
@@ -55,7 +55,7 @@ Backend.Tests/bin/Avatars/*
 mongo_database
 
 # User Guide
-user_guide/site
+docs/user_guide/site
 
 # Vagrant instances
 .vagrant/

diff --git a/Backend/Services/WordApiServices.cs b/Backend/Services/WordApiServices.cs
@@ -135,7 +135,7 @@ public async Task<List<Word>> Merge(string projectId, MergeWords mergeWords)
             addParent.History = new List<string>();
             addParent.Audio = new List<string>();
 
-            // Generate new child words form child word field
+            // Generate new child words from ChildrenWords.
             foreach (var newChildWordState in mergeWords.ChildrenWords)
             {
                 // Get child word
@@ -145,16 +145,16 @@ public async Task<List<Word>> Merge(string projectId, MergeWords mergeWords)
                     throw new KeyNotFoundException($"Unable to locate word: ${newChildWordState.SrcWordId}");
                 }
 
-                // Copy over audio if child doesn't have own surviving entry
+                // Copy over audio if child doesn't have own surviving entry.
                 if (!newChildWordState.SenseStates.Exists(x => x == State.Separate))
                 {
                     addParent.Audio.AddRange(currentChildWord.Audio);
                 }
 
-                // Remove child from frontier
+                // Remove child from frontier.
                 await _repo.DeleteFrontier(projectId, currentChildWord.Id);
 
-                // Iterate through senses of that word and change to corresponding state in mergewords
+                // Iterate through senses of that word and change to corresponding state in mergewords.
                 if (currentChildWord.Senses.Count != newChildWordState.SenseStates.Count)
                 {
                     throw new FormatException("Sense counts don't match");

diff --git a/Dockerfile b/Dockerfile
@@ -11,7 +11,7 @@ RUN pip install --upgrade pip && \
     pip install tox
 
 COPY dev-requirements.txt tox.ini ./
-COPY user_guide user_guide
+COPY docs/user_guide docs/user_guide
 
 RUN tox -e user-guide
 
@@ -41,7 +41,7 @@ RUN mkdir ${FRONTEND_HOST_DIR}/nuc
 RUN mkdir ${FRONTEND_HOST_DIR}/url_moved
 
 # Setup web content
-COPY --from=user_guide_builder /app/user_guide/site ${USER_GUIDE_HOST_DIR}
+COPY --from=user_guide_builder /app/docs/user_guide/site ${USER_GUIDE_HOST_DIR}
 COPY --from=frontend_builder /app/build ${FRONTEND_HOST_DIR}
 COPY nginx/pages/nuc_home.html ${FRONTEND_HOST_DIR}/nuc/index.html
 COPY nginx/pages/url_moved_home.html /etc/nginx/page_templates/url_moved_home.html

diff --git a/README.md b/README.md
@@ -76,8 +76,8 @@ A rapid word collection tool.
 
 6. Run `npm start` from the project directory to install dependencies and start the project.
 
-7. Consult our [C#](docs/c_sharp_style_guide.md) and [JavaScript/TypeScript](docs/ts_style_guide.md) style guides for
-   best coding practices in this project.
+7. Consult our [C#](docs/style_guide/c_sharp_style_guide.md) and [TypeScript](docs/style_guide/ts_style_guide.md)
+   style guides for best coding practices in this project.
 
 [chocolatey]: https://chocolatey.org/
 
@@ -391,7 +391,7 @@ To build the user guide and serve it dynamically (automatically reloading on cha
 (venv) $ tox -e user-guide-serve
 ```
 
-To build the user guide statically into `user-guide/site`:
+To build the user guide statically into `docs/user-guide/site`:
 
 ```bash
 (venv) $ tox -e user-guide

diff --git a/...ng_notes/5-30_Cleaner_Workflow/cards1.jpg → ...irements/5-30_Cleaner_Workflow/cards1.jpg b/...ng_notes/5-30_Cleaner_Workflow/cards1.jpg → ...irements/5-30_Cleaner_Workflow/cards1.jpg
diff --git a/...ng_notes/5-30_Cleaner_Workflow/cards2.jpg → ...irements/5-30_Cleaner_Workflow/cards2.jpg b/...ng_notes/5-30_Cleaner_Workflow/cards2.jpg → ...irements/5-30_Cleaner_Workflow/cards2.jpg
diff --git a/...Cleaner_Workflow/cleaner_workflow_5-30.md → ...Cleaner_Workflow/cleaner_workflow_5-30.md b/...Cleaner_Workflow/cleaner_workflow_5-30.md → ...Cleaner_Workflow/cleaner_workflow_5-30.md
diff --git a/...notes/5-30_Cleaner_Workflow/progress1.jpg → ...ments/5-30_Cleaner_Workflow/progress1.jpg b/...notes/5-30_Cleaner_Workflow/progress1.jpg → ...ments/5-30_Cleaner_Workflow/progress1.jpg
diff --git a/...notes/5-30_Cleaner_Workflow/progress2.jpg → ...ments/5-30_Cleaner_Workflow/progress2.jpg b/...notes/5-30_Cleaner_Workflow/progress2.jpg → ...ments/5-30_Cleaner_Workflow/progress2.jpg
diff --git a/..._notes/5-30_Cleaner_Workflow/sketches.jpg → ...ements/5-30_Cleaner_Workflow/sketches.jpg b/..._notes/5-30_Cleaner_Workflow/sketches.jpg → ...ements/5-30_Cleaner_Workflow/sketches.jpg
diff --git a/docs/meeting_notes/5-30_images/cards1.jpg → docs/requirements/5-30_images/cards1.jpg b/docs/meeting_notes/5-30_images/cards1.jpg → docs/requirements/5-30_images/cards1.jpg
diff --git a/docs/meeting_notes/5-30_images/cards2.jpg → docs/requirements/5-30_images/cards2.jpg b/docs/meeting_notes/5-30_images/cards2.jpg → docs/requirements/5-30_images/cards2.jpg
diff --git a/docs/meeting_notes/5-30_images/progress1.jpg → docs/requirements/5-30_images/progress1.jpg b/docs/meeting_notes/5-30_images/progress1.jpg → docs/requirements/5-30_images/progress1.jpg
diff --git a/docs/meeting_notes/5-30_images/progress2.jpg → docs/requirements/5-30_images/progress2.jpg b/docs/meeting_notes/5-30_images/progress2.jpg → docs/requirements/5-30_images/progress2.jpg
diff --git a/docs/meeting_notes/5-30_images/sketches.jpg → docs/requirements/5-30_images/sketches.jpg b/docs/meeting_notes/5-30_images/sketches.jpg → docs/requirements/5-30_images/sketches.jpg
diff --git a/...ng_notes/RWC Tool Requirements Review.pdf → ...irements/RWC Tool Requirements Review.pdf b/...ng_notes/RWC Tool Requirements Review.pdf → ...irements/RWC Tool Requirements Review.pdf
diff --git a/docs/Requirements for RWC Appliance.pdf → ...ements/Requirements for RWC Appliance.pdf b/docs/Requirements for RWC Appliance.pdf → ...ements/Requirements for RWC Appliance.pdf
diff --git a/docs/meeting_notes/cleaner_workflow_5-30.md → docs/requirements/cleaner_workflow_5-30.md b/docs/meeting_notes/cleaner_workflow_5-30.md → docs/requirements/cleaner_workflow_5-30.md
diff --git a/docs/meeting_notes/user_tests/user_tests.md → docs/requirements/user_tests/user_tests.md b/docs/meeting_notes/user_tests/user_tests.md → docs/requirements/user_tests/user_tests.md
diff --git a/docs/c_sharp_style_guide.md → docs/style_guide/c_sharp_style_guide.md b/docs/c_sharp_style_guide.md → docs/style_guide/c_sharp_style_guide.md
diff --git a/docs/ts_style_guide.md → docs/style_guide/ts_style_guide.md b/docs/ts_style_guide.md → docs/style_guide/ts_style_guide.md
diff --git a/user_guide/docs/account.md → docs/user_guide/docs/account.md b/user_guide/docs/account.md → docs/user_guide/docs/account.md
diff --git a/user_guide/docs/admin.md → docs/user_guide/docs/admin.md b/user_guide/docs/admin.md → docs/user_guide/docs/admin.md
diff --git a/user_guide/docs/dataEntry.md → docs/user_guide/docs/dataEntry.md b/user_guide/docs/dataEntry.md → docs/user_guide/docs/dataEntry.md
diff --git a/user_guide/docs/goals.md → docs/user_guide/docs/goals.md b/user_guide/docs/goals.md → docs/user_guide/docs/goals.md
diff --git a/user_guide/docs/images/favicon.ico → docs/user_guide/docs/images/favicon.ico b/user_guide/docs/images/favicon.ico → docs/user_guide/docs/images/favicon.ico
diff --git a/user_guide/docs/images/login.png → docs/user_guide/docs/images/login.png b/user_guide/docs/images/login.png → docs/user_guide/docs/images/login.png
diff --git a/...uide/docs/images/projectCreateTzotzil.png → ...uide/docs/images/projectCreateTzotzil.png b/...uide/docs/images/projectCreateTzotzil.png → ...uide/docs/images/projectCreateTzotzil.png
diff --git a/user_guide/docs/images/userMenu.png → docs/user_guide/docs/images/userMenu.png b/user_guide/docs/images/userMenu.png → docs/user_guide/docs/images/userMenu.png
diff --git a/user_guide/docs/images/userMenuAdmin.png → .../user_guide/docs/images/userMenuAdmin.png b/user_guide/docs/images/userMenuAdmin.png → .../user_guide/docs/images/userMenuAdmin.png
diff --git a/user_guide/docs/index.md → docs/user_guide/docs/index.md b/user_guide/docs/index.md → docs/user_guide/docs/index.md
diff --git a/user_guide/docs/project.md → docs/user_guide/docs/project.md b/user_guide/docs/project.md → docs/user_guide/docs/project.md
diff --git a/user_guide/mkdocs.yml → docs/user_guide/mkdocs.yml b/user_guide/mkdocs.yml → docs/user_guide/mkdocs.yml
diff --git a/package.json b/package.json
@@ -12,8 +12,8 @@
     "eject": "react-scripts eject",
     "fmt-backend": "dotnet-format",
     "fmt-backend-check": "dotnet-format --check",
-    "fmt-frontend": "prettier --write \"./{.github,.vscode,certmgr,deploy,docs,public,scripts,src,user_guide/docs}/**/*.{js,jsx,ts,tsx,json,md,yml}\"",
-    "fmt-frontend-check": "prettier --check \"./{.github,.vscode,certmgr,deploy,docs,public,scripts,src,user_guide/docs}/**/*.{js,jsx,ts,tsx,json,md,yml}\"",
+    "fmt-frontend": "prettier --write \"./{.github,.vscode,certmgr,deploy,docs,public,scripts,src,docs/user_guide/docs}/**/*.{js,jsx,ts,tsx,json,md,yml}\"",
+    "fmt-frontend-check": "prettier --check \"./{.github,.vscode,certmgr,deploy,docs,public,scripts,src,docs/user_guide/docs}/**/*.{js,jsx,ts,tsx,json,md,yml}\"",
     "frontend": "react-scripts start",
     "gen-backend-coverage-report": "tsc scripts/genBackendCoverageReport.ts && node scripts/genBackendCoverageReport.js",
     "import-sem-doms": "tsc scripts/importSemanticDomains.ts && node scripts/importSemanticDomains.js",

diff --git a/tox.ini b/tox.ini
@@ -49,13 +49,13 @@ commands =
 [testenv:user-guide]
 deps =
     -r{toxinidir}/dev-requirements.txt
-changedir = {toxinidir}/user_guide
+changedir = {toxinidir}/docs/user_guide
 commands =
     mkdocs build
 
 [testenv:user-guide-serve]
 deps =
     -r{toxinidir}/dev-requirements.txt
-changedir = {toxinidir}/user_guide
+changedir = {toxinidir}/docs/user_guide
 commands =
     mkdocs serve