Rules of documentation

Here describe rules for what components uses

Heading 1 - use for category on page

Heading 2 - use for title on page

Heading 3 - use for subtitle on page

  • - use for non related items

  1. - use for related items

Use for additional information that maybe useful for additional usage

Use for additional information that maybe bad for additional usage

Do not do this

Do this

Quote - why this decision was made, if the issue was controversial

Here any code
Use table to show different choises

php

8.1

Use tabs if you have many same examples with different options

Use it for important title and non important description

DevOps - use link to show where you can find more info

Examples

You can choose any language to programming

  • php

  • python

  • js

  • java

But only one db for one project you have to use:

  1. Mysql

  2. Postgresql

  3. MariaDb

  4. Sqlite

Database migration

To migrate your db you can use command:

php artisan migrate

use --force flag if your environment is production

It's dangerous to use --force flag if your environment is local

Run unit test in laravel sail

Do not run so:php artisan test

Run test this command: sail artisan test

Use number in php variables

In our project we do not create with name like: $model1, $model2 we prefer $modelOne, $modelTwo

you can prefer and use $model1, just use one code style in project

Technologies and versions

Technique
Version

php

8.2

laravel

10

Tailwind margin bottom

mt-2

Docker

Official installation docs here
sudo apt-get update

sudo apt-get install \
    ca-certificates \
    curl \
    gnupg \
    lsb-release

sudo mkdir -p /etc/apt/keyrings

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg

echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
  
sudo apt-get update

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin

sudo service docker start

sudo docker run hello-world

Do not use:

  1. Inline image

  2. Math & TeX

  3. Task list

  4. Insert files

  5. Insert images

  6. Embed url

  7. Cards

  8. Drawing

  9. API method

  10. Open API

  11. Page Link

Last updated