Commit 6f2afad5 authored by Fabrice Gangler's avatar Fabrice Gangler 🎨
Browse files

CI: fix markdown violations

parent f7c3ed3d
Pipeline #21482 passed with stages
in 48 seconds
......@@ -9,22 +9,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- allow to use API Entreprise (staging server): customize API_ENTREPRISE_URL and API_ENTREPRISE_KEY in DS .env file
- Vagrant message: add documentation to precompile assets (CSS, JS, ...)
- allow to use API Entreprise (staging server):
customize API_ENTREPRISE_URL and API_ENTREPRISE_KEY in DS .env file
## v5.1.0, 2021.12.20
### Added
- allow to use quickly API Particulier (staging server): customize API_PARTICULIER_URL and ENCRYPTION_SERVICE_SALT in DS .env file
- allow to use quickly API Particulier (staging server):
customize API_PARTICULIER_URL and ENCRYPTION_SERVICE_SALT in DS .env file
## v5.0.0, 2021.12.07
### Changed
- #34 - Update ruby verion (3.0.3 instead off 2.7.1) <br>
requires a DS software version greater than
or equal to [`2021-11-30-02`](https://github.com/betagouv/demarches-simplifiees.fr/releases/tag/2021-11-30-02)
- **#34** - Update ruby verion (3.0.3 instead off 2.7.1)
> requires a DS software version greater than
> or equal to [`2021-11-30-02`](https://github.com/betagouv/demarches-simplifiees.fr/releases/tag/2021-11-30-02)
### Added
......@@ -51,20 +54,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## v3.0.0, 2020.11.26
### Fixed
- #25 - Vagrant user can use psql easily
### Fixed
- #25 - Vagrant user can use psql easily
- Improve helping message to show after vagrant up
### Changed
- Change VM name (`DEV_demarches-simplifiees` instead off `DemarchesSimplifiees`)
- Change database user/role/password and database name
- Rename source directory (`./src/` instead off `./demarches-simplifiees.fr/`)
- Change database user/role/password and database name
- Rename source directory (`./src/` instead off `./demarches-simplifiees.fr/`)
### Removed
- Remove unnecessary prerequisite Tmux
......@@ -72,7 +75,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
- #19 - Update ruby verion (2.7.1 instead off 2.6.5)
- #19 - Update ruby verion (2.7.1 instead off 2.6.5)
## v2.0.0, 2020.08.04
......
......@@ -2,7 +2,10 @@
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for
everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity
and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion,
or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
......@@ -18,70 +21,84 @@ Examples of behavior that contributes to a positive environment for our communit
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
* Publishing others' private information, such as a physical or email address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take
appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing
the community in public spaces. Examples of representing our community include using an official e-mail address, posting
via an official social media account, or acting as an appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
leaders responsible for enforcement at [https://adullact.org/contact](https://adullact.org/contact).
All complaints will be reviewed and investigated promptly and fairly.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible
for enforcement at [https://adullact.org/contact](https://adullact.org/contact). All complaints will be reviewed and
investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem
in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the
community.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation
and an explanation of why the behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of actions.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including
unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding
interactions in community spaces as well as external channels like social media. Violating these terms may lead to a
temporary or permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified
period of time. No public or private interaction with the people involved, including unsolicited interaction with those
enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate
behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available
at [www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
Community Impact Guidelines were inspired
by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
[homepage]: <https://www.contributor-covenant.org>
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
<https://www.contributor-covenant.org/faq>. Translations are available
at <https://www.contributor-covenant.org/translations>.
# Vagrant DEV for "Démarches Simplifiées" (DS)
- Vagrant box for "Démarches Simplifiées" (DS) software development.
- Vagrant box for "Démarches Simplifiées" (DS) software development.
- Tooling for contributing to DS source code.
## Prerequisites
......@@ -9,20 +9,90 @@
- [VirtualBox](https://www.virtualbox.org/)
- Git
- a Ruby version management tool like RVM or [RBenv](https://github.com/rbenv/rbenv)
- r10k (`gem install r10k`)
- r10k (`gem install r10k`)
For Linux users (debian, ubuntu), do *not* install Vagrant and VirtualBox from `apt-get` (packages are way too old),
For Linux users (debian, ubuntu), do **not** install Vagrant and VirtualBox from `apt-get` (packages are way too old),
download `.deb` from the respective websites.
## Documentation
see: [Documentation - DevOps/developer/vagrant](https://gitlab.adullact.net/demarches-simplifiees/demarches-simplifiees-documentation/-/tree/main/DevOps/developer/vagrant)
see:
[Documentation - DevOps/developer/vagrant](https://gitlab.adullact.net/demarches-simplifiees/demarches-simplifiees-documentation/-/tree/main/DevOps/developer/vagrant)
- [Step 1: Prerequisites and build Vagrant box](https://gitlab.adullact.net/demarches-simplifiees/demarches-simplifiees-documentation/-/tree/main/DevOps/developer/vagrant/step1_Prerequisites-and-Install.md)
- [Step 2: Last manual steps for installation of Démarches simplifiées](https://gitlab.adullact.net/demarches-simplifiees/demarches-simplifiees-documentation/-/tree/main/DevOps/developer/vagrant/step2_configuration_last_manual_steps.md)
### Message show after `vagrant up` command line
```bash
==> ds: Machine 'ds' has a post `vagrant up` message. This is a message
==> ds: from the creator of the Vagrantfile, and not from Vagrant itself:
==> ds:
==> ds: ------------------------------------------------------------------
==> ds: /!\ Created for testing purpose only,
==> ds: no security has been made for production
==> ds: ------------------------------------------------------------------
==> ds:
==> ds: # LOG - To see application log
==> ds: vagrant ssh -c 'cd src; tail -f log/development.log'
==> ds:
==> ds: # CONFIG - To see application configuration (environment name, schema version, Ruby/Rails version)
==> ds: vagrant ssh -c 'cd src; bin/rake about'
==> ds:
==> ds: # CONFIG - To see .env file
==> ds: vagrant ssh -c 'cd src; cat .env'
==> ds:
==> ds: ------------------------------------------------------------------
==> ds:
==> ds: # TEST - Before running ruby tests
==> ds: vagrant ssh -c 'sudo -u postgres psql -c "ALTER USER tps_test WITH SUPERUSER;"'
==> ds:
==> ds: # TEST - Run all ruby tests (spec files)
==> ds: vagrant ssh -c 'cd src; bin/rspec'
==> ds:
==> ds: ------------------------------------------------------------------
==> ds:
==> ds: # LINT - Run all Linters (RuboCop, HAML-Lint, SCSS-Lint, ESLint, HAML-Lint)
==> ds: vagrant ssh -c 'cd src; bin/rake lint'
==> ds:
==> ds: # DATABASE - Launch PostgreSQL interactive terminal
==> ds: vagrant ssh -c 'psql'
==> ds:
==> ds: ------------------------------------------------------------------
==> ds:
==> ds: # UPDATE - Update dependencies and database (useful if you have updated the DS repository)
==> ds: vagrant ssh -c 'cd src; bin/update'
==> ds:
==> ds: # INSTALL - Finalize installation (1)
==> ds: vagrant ssh -c 'cd src; bin/setup'
==> ds:
==> ds: # Precompile assets (CSS, JS, ...)
==> ds: vagrant ssh -c 'cd src; rails assets:precompile'
==> ds:
==> ds: # PUMA - Start server to be able to restart it quickly (use Ctrl-C to stop it)
==> ds: vagrant ssh -c 'cd src; RAILS_QUEUE_ADAPTER=delayed_job; bin/rails server --binding=0.0.0.0'
==> ds:
==> ds: ------------------------------------------------------------------
==> ds: Use 'vagrant port' command line to see port mapping.
==> ds: Default : 3000 (guest) --> 3000 (host) Puma server port
==> ds: ------------------------------------------------------------------
==> ds: Super-Admin dashboard .... http://localhost:3000/manager/
==> ds: To enable features .... http://localhost:3000/manager/features/
==> ds: ------------------------------------------------------------------
==> ds: Webmail ........ http://localhost:3000/letter_opener
==> ds: Webapp ........ http://localhost:3000 -----> fisrt run: see (1)
==> ds: ------------------------------------------------------------------
==> ds: Login .......... test@exemple.fr
==> ds: Password ....... this is a very complicated password !
==> ds:
==> ds: Above user has following roles:
==> ds: "user", "instructor", "administrator" and "super-admin"
==> ds: ------------------------------------------------------------------
```
### Temporary documentation
Temporary documentation to access the database <br>
Temporary documentation to access the database
from an IDE (pending the use of Puppet to do this):
- database URL: `jdbc:postgresql://localhost:5439/vagrant`
......@@ -37,4 +107,4 @@ sed -i -e "s/listen_addresses = 'localhost'/listen_addresses = '*'/" "${ETC_PG_D
sed -i -e "s/#listen_addresses = /listen_addresses = /" "${ETC_PG_DIRECTORY}/postgresql.conf"
echo "host all all 10.0.2.2/32 md5" >>"${ETC_PG_DIRECTORY}/pg_hba.conf"
service postgresql restart
```
\ No newline at end of file
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment