diff --git a/docs/config/dot_qaskx.md b/docs/config/dot_qaskx.md new file mode 100644 index 0000000..4d64b00 --- /dev/null +++ b/docs/config/dot_qaskx.md @@ -0,0 +1,29 @@ +# .qaskx file + +The .qaskx (dotqaskx) file is normally located in +your home directory. The file is a basic, short +configuration file for items that are shared +across projects, such as your Git details. + +A sample file is: + +```json +{ + "GitProvider": "git", + "GitHost": "https://tea.example.com", + "GitApi": "https://tea.example.com/api/v1", + "GitOrg": "Wardrobe", + "GitRepoUser": "meerkat", + "GitBranch": "main", + "GitUserEmail": "meerkat@example.com", + "Organisation": "Witch & Wardrobe", + "TemplateHost": "", + "TemplateFolder": "Xtreme/Folder/Template", + "Name": "Sir Meerkat", + "ServiceOwner": "Meerkat team, Sydney", + "ServiceOwnerEmail": "Meerkat.Team@example.com", + "PrimaryProgramLanguage": "go", + "LintApiLevel": "" +} +``` + diff --git a/docs/project_start.md b/docs/project_start.md index c617f09..b640a34 100644 --- a/docs/project_start.md +++ b/docs/project_start.md @@ -1,7 +1,19 @@ -# Project flow +# Project flow (start) -_This document under construction._ +The project inception is when the scope of the project is +defined, but design and coding does not start immediately. +**Pause and reflect before starting to design and pause again +to reflect on the design before starting to code.** + +With experience you will find that many times your initial gut instinct +on design is correct, but **many is not the same as always**. With the right +tools, refactoring does allow you to change designs/code quickly - but a +pause over lunch or a night's sleep costs little and can help +you organise your approach. + +The sequence diagram below starts when you have an idea that you need +new code and existing code cannot be modified to suit your needs. ## Sequence diagram diff --git a/docs/setup.md b/docs/setup.md index 6a3a24a..1c0804d 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -27,6 +27,56 @@ The server based software above could be executed as docker images on your local desktop, but this would be only for demonstration purposes. +Configuring and initialising the software above is left for you to follow +any existing standards you may have. The qaskc-cli setup is below. + +## Sequence diagram + +The qaskx-cli has a setup command that creates the basic configuration +files that it uses. If or when you need to change the defaults, you will +commonly make the changes permanent by changing the configuration files. + +This includes items such as: + +* Your details and your organisation +* Your git details +* Preferred programming language +* Template (remote) locations + +You can read further information on each file in documents: + +* [.qaskx](config/dotaskx.md) + +Now have a look at the steps below to setup the files. + +```mermaid + +sequenceDiagram + + + actor person as Team Member + participant term as Terminal + participant qaskx as qaskx-cli + participant home as home dir + participant prj as projects dir + + person ->>+ term: start + + Note over term, qaskx: Setup qaskx-cli tool + + term ->>+ qaskx: + Note over qaskx, home: qaskx-cli setup configure cmd + qaskx ->>+ home: + home -->>- qaskx: New .qaskx file created + qaskx ->>+ prj: + prj -->>- qaskx: New config file created + qaskx -->>- term: Success + + Note over term, home: You can rerun the configure or modify config file + + term -->>- person: + +``` # End Status of flow