Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 6 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
Expand All @@ -10,3 +9,9 @@ trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.{md,yaml,yml}]
charset = utf-8-bom

[*.{env,sh,tf,tfpl}]
charset = utf-8
36 changes: 15 additions & 21 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,29 @@
name: CI
name: CI

on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch: {}

env:
python_version: "3.10"
concurrency:
group: "${{ github.ref }}-ci"
cancel-in-progress: true

jobs:
check-code:
markup-lint:
name: Markup
uses: devpro/github-workflow-parts/.github/workflows/reusable-markup-lint.yml@c90ba46a93ca90123f57744b47e49c1a73962cea

code-quality:
name: Code / Quality
runs-on: ubuntu-latest
steps:
- name: Checks-out the repository
uses: actions/checkout@v4
- name: Lints Markdown files
uses: DavidAnson/markdownlint-cli2-action@v16
with:
globs: '**/*.md'
- name: Set up Python ${{ env.python_version }}
uses: actions/setup-python@v5
with:
python-version: ${{ env.python_version }}
- name: Install Pythons packages
run: |
python -m pip install --upgrade pip
pip install yamllint
- name: Lint YAML files
run: |
yamllint .
- name: Clone repository
uses: actions/checkout@v6
- name: Install JavaScript dependencies
run: npm install
- name: Build website
Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Deploy
name: Deploy

on:
push:
Expand All @@ -11,10 +11,12 @@ jobs:
name: Build website
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Clone repository
uses: actions/checkout@v6
with:
fetch-depth: 0
- uses: actions/setup-node@v5
- name: Install Node
uses: actions/setup-node@v5
with:
node-version: 22
cache: npm
Expand Down
12 changes: 12 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
gitignore: true
ignores:
- "**/node_modules/**"
config:
# ref. https://github.com/DavidAnson/markdownlint
default: true
# MD007:
# indent: 4 # needed by PyMdown Extensions
MD013:
line_length: 350
MD033: false
MD046: false
8 changes: 0 additions & 8 deletions .markdownlint.yml

This file was deleted.

11 changes: 7 additions & 4 deletions .yamllint.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
extends: default
# ref. https://yamllint.readthedocs.io/en/stable/configuration.html

extends: default

ignore:
- 'samples/*/helm/charts/*/templates/**'
- 'node_modules/**'
rules:
document-start: disable
line-length:
level: warning
max: 120
max: 170
truthy: disable
brackets:
max-spaces-inside: 1
18 changes: 16 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Contributing
# Contributing

[![GitLab Pipeline Status](https://gitlab.com/devpro-labs/enablement/tech-notes/badges/main/pipeline.svg)](https://gitlab.com/devpro-labs/enablement/tech-notes/-/pipelines)

This website is built using [Docusaurus](https://docusaurus.io/) ([facebook/docusaurus](https://github.com/facebook/docusaurus)), a modern static website generator.

## Run locally

Make sure [Node.js](https://nodejs.org/en/download/) (version 18.0 or above) is installed.
Make sure [Node.js](https://nodejs.org/en/download/) (LTS or above) is installed.

Install the dependencies:

Expand Down Expand Up @@ -51,6 +53,18 @@ Files are in `src/theme/DocItem/Layout`.

## Lint before committing

Check YAML files:

```bash
docker run --rm -v "$(pwd)":/data cytopia/yamllint .
```

Check Markdown files:

```bash
docker run --rm -v "$(pwd)":/workdir davidanson/markdownlint-cli2 "**/*.md"
```

Reproduce locally GitLab jobs:

```bash
Expand Down
63 changes: 34 additions & 29 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Attribution-NonCommercial-NoDerivatives 4.0 International
Attribution-NonCommercial 4.0 International

=======================================================================

Expand Down Expand Up @@ -54,18 +54,18 @@ exhaustive, and do not form part of our licenses.

=======================================================================

Creative Commons Attribution-NonCommercial-NoDerivatives 4.0
International Public License
Creative Commons Attribution-NonCommercial 4.0 International Public
License

By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution-NonCommercial-NoDerivatives 4.0 International Public
License ("Public License"). To the extent this Public License may be
interpreted as a contract, You are granted the Licensed Rights in
consideration of Your acceptance of these terms and conditions, and the
Licensor grants You such rights in consideration of benefits the
Licensor receives from making the Licensed Material available under
these terms and conditions.
Attribution-NonCommercial 4.0 International Public License ("Public
License"). To the extent this Public License may be interpreted as a
contract, You are granted the Licensed Rights in consideration of Your
acceptance of these terms and conditions, and the Licensor grants You
such rights in consideration of benefits the Licensor receives from
making the Licensed Material available under these terms and
conditions.


Section 1 -- Definitions.
Expand All @@ -80,59 +80,62 @@ Section 1 -- Definitions.
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.

b. Copyright and Similar Rights means copyright and/or similar rights
b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.

c. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.

c. Effective Technological Measures means those measures that, in the
d. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.

d. Exceptions and Limitations means fair use, fair dealing, and/or
e. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.

e. Licensed Material means the artistic or literary work, database,
f. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.

f. Licensed Rights means the rights granted to You subject to the
g. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.

g. Licensor means the individual(s) or entity(ies) granting rights
h. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.

h. NonCommercial means not primarily intended for or directed towards
i. NonCommercial means not primarily intended for or directed towards
commercial advantage or monetary compensation. For purposes of
this Public License, the exchange of the Licensed Material for
other material subject to Copyright and Similar Rights by digital
file-sharing or similar means is NonCommercial provided there is
no payment of monetary compensation in connection with the
exchange.

i. Share means to provide material to the public by any means or
j. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.

j. Sui Generis Database Rights means rights other than copyright
k. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.

k. You means the individual or entity exercising the Licensed Rights
l. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.


Expand All @@ -148,8 +151,8 @@ Section 2 -- Scope.
a. reproduce and Share the Licensed Material, in whole or
in part, for NonCommercial purposes only; and

b. produce and reproduce, but not Share, Adapted Material
for NonCommercial purposes only.
b. produce, reproduce, and Share Adapted Material for
NonCommercial purposes only.

2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
Expand Down Expand Up @@ -223,7 +226,8 @@ following conditions.

a. Attribution.

1. If You Share the Licensed Material, You must:
1. If You Share the Licensed Material (including in modified
form), You must:

a. retain the following if it is supplied by the Licensor
with the Licensed Material:
Expand Down Expand Up @@ -251,9 +255,6 @@ following conditions.
Public License, and include the text of, or the URI or
hyperlink to, this Public License.

For the avoidance of doubt, You do not have permission under
this Public License to Share Adapted Material.

2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
Expand All @@ -265,6 +266,10 @@ following conditions.
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.

4. If You Share Adapted Material You produce, the Adapter's
License You apply must not prevent recipients of the Adapted
Material from complying with this Public License.


Section 4 -- Sui Generis Database Rights.

Expand All @@ -274,7 +279,7 @@ apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database for NonCommercial purposes
only and provided You do not Share Adapted Material;
only;

b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Expand Down Expand Up @@ -385,7 +390,7 @@ Section 8 -- Interpretation.
Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the "Licensor". The text of the Creative Commons
will be considered the Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# DevPro Technical Notes
# DevPro Technical Notes

[![GitLab Pipeline Status](https://gitlab.com/devpro-labs/enablement/tech-notes/badges/main/pipeline.svg)](https://gitlab.com/devpro-labs/enablement/tech-notes/-/pipelines)
[![GitHub Action CI status](https://github.com/devpro/tech-notes/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/devpro/tech-notes/actions/workflows/ci.yml)
[![GitHub Action Deploy status](https://github.com/devpro/tech-notes/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/devpro/tech-notes/actions/workflows/deploy.yml)

Source for [tech.devpro.fr](https://tech.devpro.fr).
Feel free to [contribute](CONTRIBUTING.md)!

License: [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/)

## Sections

* [Fundamentals](docs/fundamentals/fundamentals.md)
Expand Down
36 changes: 21 additions & 15 deletions docs/fundamentals/standards/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,30 @@

## IT

Accronym | Meaning
---------|--------------------------------------------------------------
BGP | Border Gateway Protocol
DKIM | Domain Keys Identified Mail
DMARC | Domain-based Message Authentication Reporting and Conformance
FOSS | Free and open source software
SRE | Site Reliability Engineering
SPF | Sender Policy Framework
Acronym | Meaning
--------|--------------------------------------------------------------
BGP | Border Gateway Protocol
DKIM | Domain Keys Identified Mail
DMARC | Domain-based Message Authentication Reporting and Conformance
FOSS | Free and open source software
SRE | Site Reliability Engineering
SPF | Sender Policy Framework

## Programming

Accronym | Meaning | Details
---------|--------------------|-------------------------------------------------------------
DFA | Data flow analysis | A method used to understand how data moves through a program
Acronym | Meaning | Details
--------|--------------------|-------------------------------------------------------------
DFA | Data flow analysis | A method used to understand how data moves through a program

## Security

Accronym | Meaning
---------|---------------------------
NHI | Non-Human Identity
SOC | Security Operations Center
Acronym | Meaning
--------|---------------------------
CIEM | Cloud Infrastructure Entitlement Management
CNAPP | Cloud Native Application Protection Platform
CSPM | Cloud Security Posture Management
CWP | Cloud Workload Protection
DSPM | Data Security Posture Management
KSPM | Kubernetes Security Posture Management
NHI | Non-Human Identity
SOC | Security Operations Center
Loading
Loading