markdown naming convention change

51ngul4r1ty · Jan 30, 2024 · 0290e49 · 0290e49
1 parent edebd9d
commit 0290e49
Show file tree

Hide file tree

Showing 32 changed files with 65 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -15,14 +15,14 @@ Getting Started (for Contributors)
 ==================================
 
 Everyone contributing to this repo should read this document before doing
-anything else: [IMPORTANT.md](docs/IMPORTANT.md)
+anything else: [Important](docs/Important.md)
 
 For specialized instructions (to save you time trying to do various things):
-[DEV_HOWTO.md](docs/DEV_HOWTO.md)
+[Dev HowTo](docs/Dev-HowTo.md)
 
 Many code standards and conventions can be picked up from existing patterns in
 the code but it is advisable to use this resource as well:
-[CODE_STANDARDS.md](docs/CODE_STANDARDS.md)
+[Code Standards](docs/Code-Standards.md)
 
 Requirements
 ------------
@@ -129,37 +129,37 @@ Document Index
 End Users
 ---------
 
-[USER_GUIDE.md](docs/USER_GUIDE.md) -
+[User Guide](docs/User-Guide.md) -
   An entrypoint for end users of Atoll.
 
 Contributor Related
 -------------------
 
-[CODE_STANDARDS.md](docs/CODE_STANDARDS.md) -
+[Code Standards](docs/Code-Standards.md) -
   Read this!  
-[CONVENTIONS.md](docs/CONVENTIONS.md) -
+[Conventions](docs/Conventions.md) -
   Important naming conventions information.  
-[ARCHITECTURE.md](docs/ARCHITECTURE.md) -
+[Architecture](docs/Architecture.md) -
   Architecture related info  
-[CODE_ARCHITECTURE.md](docs/CODE_ARCHITECTURE.md) -
+[Code Architecture](docs/Code-Architecture.md) -
   Code-level architecture related info  
-[DEV_HOWTO.md](docs/DEV_HOWTO.md) -
+[Dev HowTo](docs/Dev-HowTo.md) -
   Contains details for how to implement things.  
-[DEPENDENCIES.md](docs/DEPENDENCIES.md) -
+[Dependencies](docs/Dependencies.md) -
   Detailed information about the npm packages used.  
-[SCRIPTS.md](docs/SCRIPTS.md) -
+[Scripts](docs/Scripts.md) -
   Detailed information about the build & npm scripts.  
-[HISTORY.md](docs/HISTORY.md) -
+[History](docs/History.md) -
   The past history of this project.  
-[POLICIES.md](docs/POLICIES.md) -
+[Policies](docs/Policies.md) -
   Github branch policies etc.  
-[GLOSSARY.md](docs/GLOSSARY.md) -
+[Glossary](docs/Glossary.md) -
   Glossary specific to this project.  
-[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) -
+[Troubleshooting](docs/Troubleshooting.md) -
   This may be useful if you're running into problems.  
-[DATA_MODEL.md](docs/dataModel/DATA_MODEL.md) -
+[Data Model](docs/dataModel/Data-Model.md) -
   Mapping the requirements to the data model.  
-[PROCESS.md](docs/PROCESS.md) -
+[Process](docs/Process.md) -
   The index document for processes that should be followed.
 
 [Github Wiki](https://github.com/51ngul4r1ty/atoll-mono/wiki)
diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md
@@ -47,7 +47,7 @@ Use of HATEOAS
 The API reponses include links and there's an index resource (`/api/v1/`) that provides named
 links so that a consuming app (or developer) can discover resource links dynamically.
 
-For more information see [ARCHITECTURE_HATEOAS.md](ARCHITECTURE_HATEOAS.md).
+For more information see [HATEOAS](Architecture-HATEOAS.md).
 
 CSS
 ===

diff --git a/docs/ARCHITECTURE_HATEOAS.md → docs/Architecture-HATEOAS.md b/docs/ARCHITECTURE_HATEOAS.md → docs/Architecture-HATEOAS.md
diff --git a/docs/CODE_ARCHITECTURE_BE_API.md → docs/Code-Architecture-BE-API.md b/docs/CODE_ARCHITECTURE_BE_API.md → docs/Code-Architecture-BE-API.md
diff --git a/docs/CODE_ARCHITECTURE_FE_API.md → docs/Code-Architecture-FE-API.md b/docs/CODE_ARCHITECTURE_FE_API.md → docs/Code-Architecture-FE-API.md
diff --git a/docs/CODE_ARCHITECTURE.md → docs/Code-Architecture.md b/docs/CODE_ARCHITECTURE.md → docs/Code-Architecture.md
@@ -6,5 +6,13 @@ general code-level architecture belongs here.  This differs from "code standards
 specifically for implementation details related to architecture.
 
 There are 2 documents that cover the code-level architecture for front-end or backend code:
-1. Front-end API framework [CODE_ARCHITECTURE_FE_API.md](CODE_ARCHITECTURE_FE_API.md) document.
-2. Back-end API code patterns [CODE_ARCHITECTURE_BE_API.md](CODE_ARCHITECTURE_BE_API.md) document.
+1.  [Front-end API framework](Code-Architecture-FE-API.md)
+2.  [Back-end API code patterns](Code-Architecture-BE-API.md)
+
+Other Docs
+==========
+
+1. Where to find out information about files in this project: [Code Map](
+    Code-Map.md)
+2. Historical information about this project that doesn't fit elsewhere, but
+    needs to tracked over time: [Log](Log.md)
diff --git a/docs/CODE_MAP.md → docs/Code-Map.md b/docs/CODE_MAP.md → docs/Code-Map.md
diff --git a/docs/CODE_STANDARDS_MARKDOWN.md → docs/Code-Standards-Markdown.md b/docs/CODE_STANDARDS_MARKDOWN.md → docs/Code-Standards-Markdown.md
diff --git a/docs/CODE_STANDARDS_NAMING.md → docs/Code-Standards-Naming.md b/docs/CODE_STANDARDS_NAMING.md → docs/Code-Standards-Naming.md
@@ -2,10 +2,10 @@ Overview
 ========
 
 This document contains only naming conventions, please refer to
-[CODE_STANDARDS.md](CODE_STANDARDS.md) for more code standards.
+[Code Standards](Code-Standards.md) for more code standards.
 
 Also, this document is intended specifically for code, so please take a look at
-[OTHER_STANDARDS_NAMING.md](OTHER_STANDARDS_NAMING.md) for other naming
+[Naming Standards](Other-Standards-Naming.md) for other naming
 conventions (for example, npm script names).
 
 General Naming

diff --git a/docs/CODE_STANDARDS_PATTERNS.md → docs/Code-Standards-Patterns.md b/docs/CODE_STANDARDS_PATTERNS.md → docs/Code-Standards-Patterns.md
diff --git a/docs/CODE_STANDARDS_TESTS.md → docs/Code-Standards-Tests.md b/docs/CODE_STANDARDS_TESTS.md → docs/Code-Standards-Tests.md
@@ -2,7 +2,7 @@ Overview
 ========
 
 This document contains only test related code standards, please refer to
-[CODE_STANDARDS.md](CODE_STANDARDS.md) for more code standards.
+[Code Standards](Code-Standards.md) for more code standards.
 
 Reasoning
 =========

diff --git a/docs/CODE_STANDARDS.md → docs/Code-Standards.md b/docs/CODE_STANDARDS.md → docs/Code-Standards.md
@@ -2,14 +2,14 @@ Overview
 ========
 
 This document contains everything except:
-1) naming conventions, please refer to [CODE_STANDARDS_NAMING.md](
-    CODE_STANDARDS_NAMING.md) for these details.
-2) test code standards, please refer to [CODE_STANDARDS_TESTS.md](
-    CODE_STANDARDS_TESTS.md) for these details.
-3) specialized patterns, please refer to [CODE_STANDARDS_PATTERNS.md](
-    CODE_STANDARDS_PATTERNS.md) for these details.
-4) markdown-specific guidelines can be found in [CODE_STANDARDS_MARKDOWN.md](
-    CODE_STANDARDS_MARKDOWN.md).
+1) naming conventions, please refer to [Naming Standards](
+    Code-Standards-Naming.md) for these details.
+2) test code standards, please refer to [Test Code Standards](
+    Code-Standards-Tests.md) for these details.
+3) specialized patterns, please refer to [Patterns](
+    Code-Standards-Patterns.md) for these details.
+4) markdown-specific guidelines can be found in [Markdown Code Standards](
+    Code-Standards-Markdown.md).
 
 File Purpose Comments
 =====================

diff --git a/docs/DEV_HOWTO.md → docs/Dev-HowTo.md b/docs/DEV_HOWTO.md → docs/Dev-HowTo.md
@@ -3,8 +3,8 @@ Overview
 
 This document explains how to do certain coding activities when contributing to
 the main project.  However, if you're instead trying to use Atoll's REST API you
-should use this document for guidance: [DEV_USING_REST_API.md](
-DEV_USING_REST_API.md)
+should use this document for guidance: [Using REST API](
+Dev-Using-REST-API.md)
 
 Extending Data Model
 ====================

diff --git a/docs/DEV_USING_REST_API.md → docs/Dev-Using-REST-API.md b/docs/DEV_USING_REST_API.md → docs/Dev-Using-REST-API.md
diff --git a/docs/HISTORY.md b/docs/HISTORY.md
@@ -4,9 +4,13 @@ Overview
 This project was set up using a combination of Manuel Bieh's template, Create
 React App and other references mentioned in this doc.
 
-The [HISTORY_SETUP.md](HISTORY_SETUP.md) document contains further detailed
+The [History Setup](History-Setup.md) document contains further detailed
 steps performed.
 
+The [Log](Log.md) document contains miscellaneous information that would
+clutter this file, but may still have some relevance, so you can also look
+there for additional historical info.
+
 Chronological History
 =====================
 

diff --git a/docs/HISTORY_SETUP.md → docs/History-Setup.md b/docs/HISTORY_SETUP.md → docs/History-Setup.md
diff --git a/docs/OTHER_STANDARDS_NAMING.md → docs/Other-Standards-Naming.md b/docs/OTHER_STANDARDS_NAMING.md → docs/Other-Standards-Naming.md
diff --git a/docs/PROCESS.md b/docs/PROCESS.md
@@ -3,4 +3,4 @@ Processes
 
 This document is an index document that will provide links to any other documents that are process related.
 
-[PROCESS_CODE_REVIEWS.md](docs/PRPROCESS_CODE_REVIEWSOCESS.md) - tips for code reviewing.
+[Code Reviews](docs/Process-Code-Reviews.md) - tips for code reviewing.
diff --git a/docs/PROCESS_CODE_REVIEWS.md → docs/Process-Code-Reviews.md b/docs/PROCESS_CODE_REVIEWS.md → docs/Process-Code-Reviews.md
diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md
@@ -26,7 +26,7 @@ As soon as the `Uncaught Invariant Violation: Invalid hook call` originating in
 
 **Resolution**
 
-* Stopped using `npm link` and instead used `yalc` (see [TOOLS.md]() for
+* Stopped using `npm link` and instead used `yalc` (see [Tools](./Tools.md) for
    details).
 
 

diff --git a/docs/USER_GUIDE.md → docs/User-Guide-Configuring.md b/docs/USER_GUIDE.md → docs/User-Guide-Configuring.md
@@ -1,8 +1,3 @@
-Overview
-========
-
-This document serves to introduce concepts that are important for a user of Atoll whatever role they're in: end-user to admin.
-
 Customizing Atoll Server Instances
 ==================================
 
@@ -12,3 +7,4 @@ Environment Variables
 | Name                          | Purpose                                                                |
 |-------------------------------|------------------------------------------------------------------------|
 | ATOLL_AUTH_EXPIRATION_SECONDS | To override recommended 5 minute default based on your security needs. |
+
diff --git a/docs/DEPLOYMENT.md → docs/User-Guide-Deployment.md b/docs/DEPLOYMENT.md → docs/User-Guide-Deployment.md
@@ -4,6 +4,10 @@ How to Install Atoll
 Heroku
 ------
 
+Historically, Atoll used to be deployed on a free Heroku instance.  However,
+the free Postgres tier (10000 row limit) was removed and it is no longer used.
+That said, you can still deploy Atoll to Heroku using these same instructions.
+
 * Set up Heroku CLI
   - replace `{app-name}` with your heroku app name in this URL:  
     https://dashboard.heroku.com/apps/{app-name}/deploy/heroku-git

diff --git a/docs/User-Guide.md b/docs/User-Guide.md
@@ -0,0 +1,8 @@
+Overview
+========
+
+This document is the launch point to access information important to all users
+of Atoll whatever role they're in: end-user to admin.
+
+[Configuring Atoll](./User-Guide-Configuring.md)
+[Deploying Atoll](./User-Guide-Deployment.md)
diff --git a/docs/dataModel/API_DATA_MODEL.md → docs/dataModel/API-Data-Model.md b/docs/dataModel/API_DATA_MODEL.md → docs/dataModel/API-Data-Model.md
diff --git a/docs/dataModel/DATA_CATALOG.md → docs/dataModel/Data-Catalog.md b/docs/dataModel/DATA_CATALOG.md → docs/dataModel/Data-Catalog.md
diff --git a/...ataModel/DATA_MODEL_BACKLOG_ITEM_PARTS.md → ...ataModel/Data-Model-Backlog-Item-Parts.md b/...ataModel/DATA_MODEL_BACKLOG_ITEM_PARTS.md → ...ataModel/Data-Model-Backlog-Item-Parts.md
@@ -1,7 +1,7 @@
 Backlog Item Parts
 ==================
 
-See [DATA_MODEL_BACKLOG_ITEMS.md](./DATA_MODEL_BACKLOG_ITEMS.md) for story/issue definition.  This document defines how backlog items
+See [Data Model Backlog Items](./Data-Model-Backlog-Items.md) for story/issue definition.  This document defines how backlog items
 are split.
 
 Overview

diff --git a/docs/dataModel/DATA_MODEL_BACKLOG_ITEMS.md → docs/dataModel/Data-Model-Backlog-Items.md b/docs/dataModel/DATA_MODEL_BACKLOG_ITEMS.md → docs/dataModel/Data-Model-Backlog-Items.md
@@ -68,10 +68,10 @@ There are a few fields that are involved and this can be confusing:
 The "Backlog Item" entity represents a Product Backlog Item (PBI).  For a PBI
 the `estimate` field is the total story point estimate for the
 
-See `Splitting vs Continuing a Story` in [./DATA_MODEL.md](./DATA_MODEL.md) for
+See `Splitting vs Continuing a Story` in [Data Model](./Data-Model.md) for
 information on splitting vs continuing stories.
 
-Also see `Continuing Stories` in [CONTINUING_STORIES.md](../requirements/CONTINUING_STORIES.md)
+Also see `Continuing Stories` in [Continuing Stories](../requirements/Continuing-Stories.md)
 
 Continuing stories (through a concept known as "backlog item parts") will
 most likely result in changing estimates.

diff --git a/docs/dataModel/DATA_MODEL_ISSUES.md → docs/dataModel/Data-Model-Issues.md b/docs/dataModel/DATA_MODEL_ISSUES.md → docs/dataModel/Data-Model-Issues.md
diff --git a/docs/dataModel/DATA_MODEL.md → docs/dataModel/Data-Model.md b/docs/dataModel/DATA_MODEL.md → docs/dataModel/Data-Model.md
diff --git a/docs/requirements/CONTINUING_STORIES.md → docs/requirements/Continuing-Stories.md b/docs/requirements/CONTINUING_STORIES.md → docs/requirements/Continuing-Stories.md
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@atoll/shared",
-  "version": "0.64.0",
+  "version": "0.65.0",
   "description": "Atoll shared code that is common to electron desktop client and web app",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

diff --git a/...ode-extension/vsc-extension-quickstart.md → ...xtension/docs/VSC-Extension-Quickstart.md b/...ode-extension/vsc-extension-quickstart.md → ...xtension/docs/VSC-Extension-Quickstart.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,4 +3,4 @@ Processes

		This document is an index document that will provide links to any other documents that are process related.

		[PROCESS_CODE_REVIEWS.md](docs/PRPROCESS_CODE_REVIEWSOCESS.md) - tips for code reviewing.
		[Code Reviews](docs/Process-Code-Reviews.md) - tips for code reviewing.