Skip to content

Commit

Permalink
The changes made to README.fr.adoc and README.adoc are:
Browse files Browse the repository at this point in the history
- **Added instructions for listing available tasks:**
    - Both files now include a section explaining how to list available Gradle tasks.
    - The command used is `.\gradlew.bat -q :tasks` for Windows and `./gradlew -q :tasks` for Linux & Mac.
- **Improved formatting and clarity:**
    - The code blocks are now consistently formatted using `[source,bash]` for better readability.
    - Bullet points are used to list available tasks, making it easier to scan and understand.
    - Comments are added to clarify the purpose of different sections and commands.
- **Minor wording changes:**
    - Some minor wording changes were made to improve clarity and consistency.

These changes make the README files more informative and user-friendly, especially for newcomers who are not familiar with Gradle tasks.
  • Loading branch information
cheroliv committed Sep 25, 2024
1 parent ba4edfe commit ca19a4a
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 85 deletions.
115 changes: 65 additions & 50 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,64 +20,79 @@ The School project is based on the link:https://gradle.org/[Gradle] software as
- Java 17
- Docker

.How to launch a task in the terminal
// .How to launch a task in the terminal
//
// _Windows_
// [source,bash]
// ----
// .\gradlew.bat :hello
// ----
//
// _Linux & Mac_
// [source,bash]
// ----
// ./gradlew :hello
// ----
//
// _Output_
// ----
// > Task :hello
// Hello from the SchoolPlugin
// ----

== Available tasks

.List available tasks

_Windows_
[source,bash]
----
.\gradlew.bat :hello
.\gradlew.bat -q :tasks
----

_Linux & Mac_
[source,bash]
----
./gradlew :hello
----

_Output_
----
> Task :hello
Hello from the SchoolPlugin
----

== Available tasks

.School
- `:initWorkspace` - Initialize workspace configuration.
- `:printDossierProfessionnelle` - Displays the internal structure of the professional dossier document in the terminal.

.School Frontend
- `:schoolFrontendServe` - Run the school site locally.
- `:schoolFrontendDesign` - Design the school site in Storybook.
- `:schoolFrontendTests` - Test the school site.
- `:schoolFrontendPublish` - Publish the school site to CDN.

.School Backoffice
- `:schoolBackofficeTests` - Test the school backoffice.
- `:schoolBackofficePush` - Pushes the school backoffice script to the Google Workspace.

.School Moodle
- `:projects:school:school-gradle-plugin:initMoodle` - Initializes the Moodle docker image in localhost.
- `:projects:school:school-gradle-plugin:launchMoodleDev` - Launches the Moodle docker image in localhost.
- `:projects:school:school-gradle-plugin:stopMoodleDev` - Stops the Moodle docker image in localhost.

.Utilities
- `:hello` - Greetings output
- `:lsWorkingDir` - Executes the `ls` command on the current module directory.
- `:confToYaml` - Utility task for development: displays configuration in yaml.
- `:printEnvVars` - Retrieves environment variables.


== Databases

.postgresql
[bash,source]
----
sudo docker compose -f ~/workspace/atelier/school/database/postgresql/postgresql.yml up -d
./gradlew -q :tasks
----

.mongodb
[bash,source]
----
sudo docker compose -f ~/workspace/atelier/school/database/mongodb/mongodb.yml up -d
----
//
// .School
// - `:initWorkspace` - Initialize workspace configuration.
// - `:printDossierProfessionnelle` - Displays the internal structure of the professional dossier document in the terminal.
//
// .School Frontend
// - `:schoolFrontendServe` - Run the school site locally.
// - `:schoolFrontendDesign` - Design the school site in Storybook.
// - `:schoolFrontendTests` - Test the school site.
// - `:schoolFrontendPublish` - Publish the school site to CDN.
//
// .School Backoffice
// - `:schoolBackofficeTests` - Test the school backoffice.
// - `:schoolBackofficePush` - Pushes the school backoffice script to the Google Workspace.
//
// .School Moodle
// - `:projects:school:school-gradle-plugin:initMoodle` - Initializes the Moodle docker image in localhost.
// - `:projects:school:school-gradle-plugin:launchMoodleDev` - Launches the Moodle docker image in localhost.
// - `:projects:school:school-gradle-plugin:stopMoodleDev` - Stops the Moodle docker image in localhost.
//
// .Utilities
// - `:hello` - Greetings output
// - `:lsWorkingDir` - Executes the `ls` command on the current module directory.
// - `:confToYaml` - Utility task for development: displays configuration in yaml.
// - `:printEnvVars` - Retrieves environment variables.
//
//
// == Databases
//
// .postgresql
// [bash,source]
// ----
// sudo docker compose -f ~/workspace/atelier/school/database/postgresql/postgresql.yml up -d
// ----
//
// .mongodb
// [bash,source]
// ----
// sudo docker compose -f ~/workspace/atelier/school/database/mongodb/mongodb.yml up -d
// ----
85 changes: 50 additions & 35 deletions README.fr.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,50 +20,65 @@ Le projet School est basé sur le logiciel link:https://gradle.org/[gradle] comm
- Java 17
- Docker

.Comment lancer une tache dans le terminal
// .Comment lancer une tache dans le terminal
//
// _Windows_
// [source,bash]
// ----
// .\gradlew.bat :hello
// ----
//
// _Linux & Mac_
// [source,bash]
// ----
// ./gradlew :hello
// ----
//
// _Sortie_
// ----
// > Task :hello
// Hello from the SchoolPlugin
// ----


== Taches disponibles

.Lister les taches disponible.

_Windows_
[source,bash]
----
.\gradlew.bat :hello
.\gradlew.bat :tasks
----

_Linux & Mac_
[source,bash]
----
./gradlew :hello
----

_Sortie_
----
> Task :hello
Hello from the SchoolPlugin
./gradlew :tasks
----


== Taches disponibles

.École
- `:initWorkspace` - Initialise la workspace configuration.
- `:printDossierProfessionnelle` - Affiche dans le terminal la structure interne du document de dossier professionnel.

.École Frontend
- `:schoolFrontendServe` - Execute du site de l'école en localhost.
- `:schoolFrontendDesign` - Design le site de l'école dans Storybook.
- `:schoolFrontendTest` - Test le site de l'école.
- `:schoolFrontendPublish` - Publie le site de l'école vers un CDN.

.École Backoffice
- `:schoolBackofficeTests` - Tester le backoffice de l'école.
- `:schoolBackofficePush` - Poussez le script backoffice de l'école vers l'espace de travail Google.

.École Moodle
- `:projects:school:school-gradle-plugin:initMoodle` - Initialise l'image docker de Moodle dans localhost.
- `:projects:school:school-gradle-plugin:launchMoodleDev` - Lance l'image docker de Moodle dans le localhost.
- `:projects:school:school-gradle-plugin:stopMoodleDev` - Arrête l'image docker de Moodle dans le localhost.

.Utilitaires
- `:hello` - Salution d'usage.
- `:lsWorkingDir` - Exécute la commande `ls` sur repertoire du module en execution.
- `:confToYaml` - Tâche utilitaire pour le développement : affiche la configuration en yaml.
- `:printEnvVars` - Récupère les variables d'environnement.
// .École
// - `:initWorkspace` - Initialise la workspace configuration.
// - `:printDossierProfessionnelle` - Affiche dans le terminal la structure interne du document de dossier professionnel.
//
// .École Frontend
// - `:schoolFrontendServe` - Execute du site de l'école en localhost.
// - `:schoolFrontendDesign` - Design le site de l'école dans Storybook.
// - `:schoolFrontendTest` - Test le site de l'école.
// - `:schoolFrontendPublish` - Publie le site de l'école vers un CDN.
//
// .École Backoffice
// - `:schoolBackofficeTests` - Tester le backoffice de l'école.
// - `:schoolBackofficePush` - Poussez le script backoffice de l'école vers l'espace de travail Google.
//
// .École Moodle
// - `:projects:school:school-gradle-plugin:initMoodle` - Initialise l'image docker de Moodle dans localhost.
// - `:projects:school:school-gradle-plugin:launchMoodleDev` - Lance l'image docker de Moodle dans le localhost.
// - `:projects:school:school-gradle-plugin:stopMoodleDev` - Arrête l'image docker de Moodle dans le localhost.
//
// .Utilitaires
// - `:hello` - Salution d'usage.
// - `:lsWorkingDir` - Exécute la commande `ls` sur repertoire du module en execution.
// - `:confToYaml` - Tâche utilitaire pour le développement : affiche la configuration en yaml.
// - `:printEnvVars` - Récupère les variables d'environnement.

0 comments on commit ca19a4a

Please sign in to comment.