Skip to content

Add A Definitions Document - #11

Open
Mekebrown wants to merge 10 commits into
mainfrom
add-definitions
Open

Mekebrown wants to merge 10 commits into
mainfrom
add-definitions

Conversation

@Mekebrown

@Mekebrown Mekebrown commented Jun 28, 2023

Copy link
Copy Markdown
Contributor

Add a definitions document to make the more niche and/or frequently-used terms clearer for all developers. This will help us better learn about what areas of the app and its meanings we are individually responsible for.

Icons in Roadmap Board of Tickets - Will have images linked after pull request #16 is merged.

@Mekebrown Mekebrown self-assigned this Jul 3, 2023
@Mekebrown
Mekebrown marked this pull request as ready for review July 3, 2023 21:59
@Mekebrown Mekebrown added the documentation Improvements or additions to documentation label Jul 3, 2023
@Mekebrown Mekebrown changed the title docs: add definitions Add A Definitions Document Jul 3, 2023
Comment thread DEFINITIONS.md Outdated
Comment thread DEFINITIONS.md
Building and running applications in a way that fully utilizes the benefits provided by cloud environments. It involves developing applications as a collection of loosely coupled, independently deployable services, often referred to as microservices, which can be scaled independently based on demand. Ex. iCloud storage

## Container
A code sandbox; A standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another. It is a unit of a runnable application inside of an image. Please see Image (Container) for more information. A holder of program images (please see Images for more information.), used for transport. Ex. A Docker container of the nginX image

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth having related terms at the end of each term, like "see Docker", with a link to Docker definition?

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, nginx has that capital X at the end.

Comment thread DEFINITIONS.md
Tests user scenarios and various path conditions by verifying that the system runs and performs tasks accurately with the same set of data from beginning to end, as intended. Ex. Observing the process of a visiting guest becoming a user with an account filled with data laid out in a test plan.

## Enhancement (Pull Request Label)
Any alteration or modification to the existing system for better workflow and process. Ex. Adding a _business_ resource type.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AKA "feature"

Comment thread DEFINITIONS.md
## Queer
A term used to describe a person who is not heterosexual. Ex. A queer senior citizen

## Refactor

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this refactor as a verb, or a noun?

Comment thread DEFINITIONS.md
## Scope Creep
When a project grows beyond its original goals and objectives. Any open-source project must keep its app's scope reasonable, especially for a first version that is free.

## SemVer

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps add a link to Semver?

Comment thread DEFINITIONS.md
3. Minor: The bug causes the system to produce incorrect, incomplete, inconsistent results, but the system is usable.

## Spike
A document consisting of a researched summary of a feature or tool that is a possible addition to the application at hand; A document that is used to determine the viability of a feature or tool. Ex. The Ory Kratos spike in [QG-docs](https://github.com/QueerGlobal/qg-docs)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice reference on the spike definition!

@mnyon-grandkru mnyon-grandkru left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the definitions document. I think another word for that is glossary. The definitions name is fine as is. I've got some small single comments, but for the most part, I like.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants