Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/add eslint #53

Merged
merged 2 commits into from
Aug 12, 2024
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
push:
branches:
- main
paths:
paths:
- docs/**
workflow_dispatch:

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
build:
name: Build application
runs-on: ubuntu-latest
needs:
needs:
- release
permissions:
contents: read
Expand Down
3 changes: 1 addition & 2 deletions .gitlab-ci-dso.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ include:
- kaniko-ci.yml
ref: main


default:
image: alpine:latest

Expand All @@ -25,7 +24,7 @@ read_secret:

docker-build:
variables:
WORKING_DIR: "."
WORKING_DIR: .
IMAGE_NAME: dso-documentation
stage: docker-build
extends:
Expand Down
94 changes: 94 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
{
// visuals
"window.autoDetectColorScheme": true,
"editor.fontLigatures": "'ss01', 'ss02', 'ss03', 'ss06', 'zero'",
"editor.cursorBlinking": "phase",
"editor.suggestSelection": "first",
"editor.wordWrap": "on",
"editor.bracketPairColorization.enabled": true,
"editor.tabSize": 2,
"editor.minimap.enabled": false,
"search.exclude": {
"**/.git": true,
"**/.nuxt": true,
"**/.pnpm": true,
"**/.vscode": true,
"**/.yarn": true,
"**/.turbo": true,
"**/dist/**": true,
"**/out/**": true,
"**/logs": true,
"**/node_modules": true,
"**/package-lock.json": true,
"**/pnpm-lock.yaml": true,
"**/yarn.lock": true
},
// general
"editor.unicodeHighlight.invisibleCharacters": false,
"workbench.startupEditor": "none",
// git
"git.autofetch": true,
"git.untrackedChanges": "separate",
// github
"githubPullRequests.pullBranch": "never",
// eslint
"editor.codeActionsOnSave": {
"source.fixAll": "never",
"source.fixAll.eslint": "explicit",
"source.organizeImports": "never"
},
"eslint.quiet": true,
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
"vue",
"html",
"markdown",
"json",
"jsonc",
"yaml",
"toml",
"xml",
"gql",
"graphql",
"astro",
"svelte",
"css",
"less",
"scss",
"pcss",
"postcss"
],
// languages
"[javascript]": {
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
},
"javascript.preferences.quoteStyle": "single",
"javascript.preferences.importModuleSpecifierEnding": "js",
"javascript.suggest.completeJSDocs": true,
"javascript.suggest.jsdoc.generateReturns": true,
"[typescript]": {
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
},
"typescript.preferences.quoteStyle": "single",
"typescript.preferences.importModuleSpecifierEnding": "js",
"typescript.suggest.completeJSDocs": true,
"typescript.suggest.jsdoc.generateReturns": true,
"[html]": {
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
},
"[markdown]": {
"editor.quickSuggestions": {
"other": true,
"comments": true,
"strings": true
},
"editor.formatOnSave": true,
"editor.formatOnPaste": true,
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
},
// conventional commits
"conventionalCommits.showNewVersionNotes": false
}
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Merci de nous aider à améliorer la plateforme de services Cloud π Native. L'e

Dans l'intérêt de favoriser un environnement ouvert et accueillant, nous, en tant que contributeurs et mainteneurs, nous engageons à faire de la participation à notre projet et à notre communauté une expérience sans harcèlement pour tous, quels que soient l'âge, la taille, le handicap, l'origine ethnique, l'identité et l'expression de genre, niveau d'expérience, nationalité, apparence personnelle, race, religion ou identité et orientation sexuelles.


## Liste des ressources

Le projet Cloud π Native est constitué d'un ensemble de repos github suivant :
Expand All @@ -28,7 +27,6 @@ Le projet Cloud π Native est constitué d'un ensemble de repos github suivant :
- Déploiement par helm chart dans un context de monorepo (code + helm dans le même repo) <https://github.com/cloud-pi-native/tuto-static-monorepo>
- Tutorial GitOps <https://github.com/cloud-pi-native/gitops-tutorial>


## Contribution

Pour contribuer au projet, vous pouvez, sur chacune des ressources ci-dessous créer une *issue* github, par exemple pour le projet de [documentation](https://github.com/cloud-pi-native/documentation/issues)
Pour contribuer au projet, vous pouvez, sur chacune des ressources ci-dessous créer une *issue* github, par exemple pour le projet de [documentation](https://github.com/cloud-pi-native/documentation/issues)
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ Ce dépôt est construit et déployé à l'adresse : <https://cloud-pi-native.fr

## L'offre

### Présentation

### Présentation

Avec l’adoption de la doctrine « Cloud au centre », le Gouvernement Français fait du Cloud un prérequis pour tout nouveau projet numérique au sein de l’État ou refonte substantielle de l’architecture applicative existante.

Expand All @@ -17,8 +16,8 @@ L'offre interministérielle Cloud π Native, offre les services d'une plateforme

La philosophie de l'offre est de créer une chaine collaborative étendue entre l'équipe de développement et l'hébergement, qui s'appuient sur :
- un socle d'intégration à la main des développeurs, appellée chaine primaire.
- un service côté infrastructure étatique effectuant la recompilation du code et l'automatisation des déploiement, appellée chaine secondaire.
- un service côté infrastructure étatique effectuant la recompilation du code et l'automatisation des déploiement, appellée chaine secondaire.

La chaine secondaire est également en charge de mesurer la qualité du code et la conduite d'audits automatisés à chaque build/déploiement contribuant à l'homologation en continu de l'application.

L'usage de standards industriels largement distribués tel que kubernetes et Gitops et la sécabilité de l'offre, permettent un transfert facilité depuis et vers d'autres solutions d'hébergement kubernetes telles que les Clouds Publics.
Expand Down Expand Up @@ -68,7 +67,7 @@ L'architecture générale de l'offre Cloud π Native est la suivante :

![](docs/public/img/architecture.png)

### SLA associés à l'offre Chaine DevSecOps secondaire
### SLA associés à l'offre Chaine DevSecOps secondaire

L'offre Cloud π Native s'appuie sur l'hébergement Cloud du ministère. Les grands services ayant des contraintes de SLA différentes :

Expand Down Expand Up @@ -102,24 +101,23 @@ Typiquement l'équipe doit être dans un parcours de montée en compétence à l

## Embarquement technique

Un parcours technique d'apprentissage permettant de valider les prérequis et d'intégrer les bonnes pratiques permet à nos clients d'appréhender l'offre Cloud π Native.
Un parcours technique d'apprentissage permettant de valider les prérequis et d'intégrer les bonnes pratiques permet à nos clients d'appréhender l'offre Cloud π Native.

![parcours_apprentissage](docs/public/img/learning-process.png)

- Etape 1 : [Matrice de compétences](docs/platform/skills-matrix.md) des technologies à connaitre pour utiliser l'offre Cloud π Native
- Etape 2 : Vérification de l'éligibilité de son application avec le modèle Cloud Native Application [prérequis](docs/platform/compatibility.md) technique liés à l'offre. Les équipes Cloud π Native [accompagnent](docs/agreement/support.md) les équipes projets sur cette étape afin d'apporter conseils et qualification des architectures et maturité technique des équipes.
- Etape 1 : [Matrice de compétences](docs/platform/skills-matrix.md) des technologies à connaitre pour utiliser l'offre Cloud π Native
- Etape 2 : Vérification de l'éligibilité de son application avec le modèle Cloud Native Application [prérequis](docs/platform/compatibility.md) technique liés à l'offre. Les équipes Cloud π Native [accompagnent](docs/agreement/support.md) les équipes projets sur cette étape afin d'apporter conseils et qualification des architectures et maturité technique des équipes.
- Etape 3 : Prise de connaissance des [bonnes pratiques](docs/guilde/best-practices.md) et expérimentation avec une série de tutoriels [tutoriels](docs/guide/tutorials.md) afin de faire ses premiers pas avec l'offre
- Etape 4 : [Embarquement](docs/guide/get-started.md) de l'application sur l'offre
- Etape 5 : Félicitation ! Vous êtes maintenant un utilisateur de la plateforme Cloud π Native et votre application peut passer en production via les principes d'[exploitation et observabilité](docs/agreement/exploitation.md) de vos projets.


A tout moment, vous pouvez consulter la [documentation détaillée](docs/platform/introduction.md) de la plateforme Cloud π Native, son architecture et les services proposés

Enfin notre [FAQ](docs/agreement/faq.md) permet de lister les questions fréquentes de nos clients, et des exemples pour réaliser des bouchons (S3, SMTP, ...)

## Notre roadmap (WIP)

L'offre Cloud π Native est en cours de construction incrémentale. Notre [feuille de route détaillée](docs/platform/roadmap.md) est accessible permettant de donner de la visibilité sur les prochaines fonctionnalités.
L'offre Cloud π Native est en cours de construction incrémentale. Notre [feuille de route détaillée](docs/platform/roadmap.md) est accessible permettant de donner de la visibilité sur les prochaines fonctionnalités.

Voici les grandes fonctionnalités prévus dans les prochaines semaines :
- Réduction de la quantité de code / manifest à produire;
Expand All @@ -141,6 +139,8 @@ L'offre Cloud π Native s'améliore grâce aux retours de nos utilisateurs, n'h
Le dépôt est construit avec [vitepress](https://vitepress.dev) à l'aide de fichiers markdown positionné dans le dossier [docs](./docs/).
Les assets (images, fichiers additionnels, etc...) sont positionnés dans le dossier [public](./docs/public/).

__Pour formater le code, veuillez à lancer la commande `pnpm run format` avant votre commit.__

Structure du dépôt :

```sh
Expand All @@ -157,4 +157,4 @@ Structure du dépôt :
├── agreement/
├── services/
└── index.md
```
```
2 changes: 1 addition & 1 deletion docs/.vitepress/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -241,4 +241,4 @@
}
]
}
]
]
2 changes: 1 addition & 1 deletion docs/administration/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ La console permet d'administrer les items suivants:
- Jounaux: liste des journaux de la console DSO pour débugger en cas de problème
- Clusters: liste des clusters, détail de chaque cluster, ajout de nouveau cluster
- Quotas: liste des quotas, détail des quotas et ajout de quota
- Types d'environnement:
- Types d'environnement:
- Zones
- Plugins: configuration des différents plugins utilisés par la console
18 changes: 9 additions & 9 deletions docs/administration/journaux.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ Dès qu'un problème apparait, l'entrée du journal est entourée en rouge (vert

```json
{
args:{
}
config:{
}
failed:[
]
results:{
}
"args": {
},
"config": {
},
"failed": [
],
"results": {
}
}
```

Expand All @@ -26,4 +26,4 @@ La clé failed contient le plugin en erreur (pour faciliter la vie de l'administ
La clé results contient les logs des différents plugins joués et donne un 1er aperçu du problème rencontré.

Dans l'exemple suivant, le projet a un soucis d'authenfication concernant GitLab. D'expérience, il s'agit très certainement d'un clonage de dépôt privé dont les informations d'identification ont été mal renseignées.
![journaux erreur](/img/console_admin/journaux_erreur.png)
![journaux erreur](/img/console_admin/journaux_erreur.png)
1 change: 0 additions & 1 deletion docs/administration/quotas.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ Pour mettre à jour un quota, il suffit de cliquer sur sa tuile dans la page pri
Si le quota est utilisé par des projets, la liste des projets et environnement est affichée.

Un quota ne peut être supprimé que s'il n'a pas de projet lié.

9 changes: 4 additions & 5 deletions docs/agreement/exploitation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ L'offre Cloud π Native permet *in fine* de déployer des applications. Le volet
- Ajout de métriques d'observabilité
- Procédures standards pour les opérations usuelles comme la sauvegarde et restauration, PRA, chargement des données.


## SLA de la plateforme

L'offre Cloud π Native s'appuie sur l'hébergement Cloud du ministère. Les grands services ayant des contraintes de SLA différentes :
Expand All @@ -28,16 +27,16 @@ Note : le SLA du cloud PI pour le fonctionnement en production des applications

## Exploitabilité

:construction: *Disponible prochainement* :construction:
:construction: *Disponible prochainement* :construction:

### Accès aux logs

:construction: *Disponible prochainement* :construction:
:construction: *Disponible prochainement* :construction:

### Accès aux métriques

:construction: *Disponible prochainement* :construction:
:construction: *Disponible prochainement* :construction:

### Sauvegarde et restauration

:construction: *Disponible prochainement* :construction:
:construction: *Disponible prochainement* :construction:
Loading