Skip to content

Commit

Permalink
Add markdown checker
Browse files Browse the repository at this point in the history
  • Loading branch information
oskarbarcz committed Dec 16, 2024
1 parent 9928f5f commit 54a2c81
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 33 deletions.
3 changes: 2 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"MD013": {
"line_length": 120
}
},
"MD028": false
}
31 changes: 4 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,10 @@ and navigable set of guidelines.

Document also will try to provide deeper context for each decision made during the development.

[//]: # (## Guiding Principles)

[//]: # ()
[//]: # (- **Security & Privacy**)

[//]: # (- **Accessibility**)

[//]: # (- **Sustainability & Maintainability**)

[//]: # (- **Open Standards & Collaboration**)

[//]: # (- **Compliance & Ethics**)

## Scope

These standards apply to:

- all frontend and backend projects developed or maintained under the Generacja Innowacja,
- internal and external communication platforms,
- infrastructure components, including servers, cloud services, and network configurations,
Expand All @@ -33,25 +21,14 @@ These standards apply to:

To learn more about specific technical standards, refer to the dedicated documents below:

- Frontend standards __(coming soon)__
- Frontend standards **(coming soon)**
- [Backend standards](docs/backend/INDEX.md)
- [GitHub repository standards](docs/github/INDEX.md)
- Infrastructure standards __(coming soon)__

[//]: # (## Other Documentation)

[//]: # ()
[//]: # (- [Coding Guidelines](./coding-guidelines.md))

[//]: # (- [Contribution Guidelines](./contribution-guidelines.md))

[//]: # (- [Security Policies](./security-policies.md))

[//]: # (- [Infrastructure Architecture](./infrastructure-architecture.md) *(optional file you may create)*)
- Infrastructure standards **(coming soon)**

## Continuous Improvement

These standards will be reviewed and updated as needed. Suggestions and feedback from all team members are encouraged
These standards will be reviewed and updated as needed. Suggestions and feedback from all team members are encouraged
to ensure our practices remain current, effective, and aligned with the organization mission.

Current document version: **0.1.0**.
7 changes: 3 additions & 4 deletions docs/backend/INDEX.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ learning curve to be a successful programmer. Make sure to check these maps out:
*"It works on my end!"* - is a known joke and phrase that everyone in IT industry heard at least once. To prevent this
kind of situations, we are using **Docker** to create development and production environments.



> **We use Docker in all backend projects in organization.**
>
> Docker is a tool designed to make it easier to create, deploy, and run applications by using containers. Containers
Expand All @@ -59,17 +57,18 @@ and ship it all out as one package.
>
> Since our backend services are almost identical when it comes to system configuration, we are using one Dockerfile
> standard across all of our projects. You can look at these repositories to see how it looks like:
>
> - [dzialaj-org-api](https://github.com/Generacja-Innowacja/dzialaj-org-api/blob/main/Dockerfile)
> - [mypolitics-survey-producer-api](https://github.com/Generacja-Innowacja/mypolitics-survey-producer-api/blob/main/Dockerfile)

> **We use multi-stage builds to keep our images as small as possible.**
>
> This way we can reduce the time needed to build and push images to the registry. On production environment we are
> using only production dependencies, without any development tools such as test libraries or other dev runtime
> packages.
Read more about Docker:

- [Docker (official docs)](https://docs.docker.com/)
- [Docker Compose (official docs)](https://docs.docker.com/compose/)

Expand All @@ -81,4 +80,4 @@ Read more about Docker:
> many features that safely store and scale the most complicated data workloads.
>
> However, since your project may have different requirements, you can use any other database. If you want to consult
> your choice, feel free to ask for advice from organization Technical Leader.
> your choice, feel free to ask for advice from organization Technical Leader.
2 changes: 1 addition & 1 deletion docs/github/INDEX.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GitHub repository standards

These guidelines ensure a consistent, maintainable, and robust backend codebase across all services developed
under our organization.
under our organization.

0 comments on commit 54a2c81

Please sign in to comment.