Vanessa vanessa

Questões sobre Documentação da Arquitetura de Sistemas

1. Perguntas

Fiz algumas perguntas nas redes sociais e ferramentas de comunicação como Twitter, LinkedIn, Slack, Discord e Telegram sobre como as pessoas costumam documentar a arquitetura de sistemas.

Vocês costumam desenhar diagramas para documentar a arquitetura dos sistemas que vocês constroem?
O que vocês costumam representar: código, infraestrutura ou ambos?

Pure ESM package

The package that linked you here is now pure ESM. It cannot be require()'d from CommonJS.

This means you have the following choices:

Use ESM yourself. (preferred)
Use import foo from 'foo' instead of const foo = require('foo') to import the package. You also need to put "type": "module" in your package.json and more. Follow the below guide.
If the package is used in an async context, you could use await import(…) from CommonJS instead of require(…).
Stay on the existing version of the package until you can move to ESM.

Github Search Cheat Sheet

GitHub’s search supports a variety of different operations. Here’s a quick cheat sheet for some of the common searches.

For more information, visit our search help section.

Basic search

Conventional Commit Messages

See how a minor change to your commit message style can make a difference.

git commit -m"<type>(<optional scope>): <description>" \
  -m"<optional body>" \
  -m"<optional footer>"

Tutorial-like

e.g. Don't Use My Grid System (or any others) https://www.youtube.com/watch?v=mDRfFEcj3-Q
e.g. Taking Django Distributed https://youtu.be/gCNj8mMoq38
e.g. Instagram Filters in 15 Lines of Python https://www.youtube.com/watch?v=otLGDpBglEA
e.g. Multitenant applications: how and why https://www.youtube.com/watch?v=yyJonajA_jI

Best/worst practices

e.g. What is wrong with API wrappers and how can we do better https://youtu.be/McMb8ZFfMXk
e.g. Dubious Database Design https://www.youtube.com/watch?v=l712XON7R2s
e.g. JS UX: Writing code for humans https://youtu.be/loj3CLHovt0

$ wget https://www.python.org/ftp/python/3.6.3/Python-3.6.3.tgz

$ tar xvf Python-3.6.3.tgz

$ cd Python-3.6.3

$ ./configure --enable-optimizations

$ make -j8

Migrations & Seeding

What are migrations??

Migrations are a way to make database changes or updates, like creating or dropping tables, as well as updating a table with new columns with constraints via generated scripts. We can build these scripts via the command line using knex command line tool.

To learn more about migrations, check out this article on the different types of database migrations!

	manage.py
	utils.py
	templates/
	- foo/
	- search.html
	foo/
	- models.py
	- views.py

	/*
	Instructions for MacOS:

	- Install the fonts 'Operator Mono' & 'Fira Code'
	- Install theme 'Dark Candy'
	- Add the following config to the VS Code settings.json:

	{
	"editor.renderWhitespace": "all",
	"editor.fontSize": 14,

	#!/usr/bin/env python
	import sys
	import subprocess

	diff_requirements = 'git diff ORIG_HEAD HEAD --exit-code -- requirements.txt'

	exit_code = subprocess.call(diff_requirements.split())
	if exit_code == 1:
	print 'The requirements file has changed! Remember to install new dependencies.'
	else: