openeuropa / documentation

European Commission DIGIT initiative fostering open source adoption in consolidating the European Institutions web presence

The OpenEuropa Initiative

OpenEuropa is a Directorate-General for Informatics (DIGIT) initiative aiming at strengthening the adoption of open source tools and practices in consolidating the European Institutions' web presence.

In order to achieve such a goal the OpenEuropa Initiative will focus on the following activities:

• Build, maintain and release loosely-coupled, reusable software components , licensed under EUPL-1.2.
• Build, maintain and release fully-fledged solutions for the European Institutions.
• Provide a high-level architecture overview of web-related information systems.
• Establish reusable technical governance guidelines.
• Contribute back to upstream open source projects.

For more information please check:

• OpenEuropa initiative
  • Code of Conduct
  • Release cycle
  • How to contribute
  • Contribution workflow
  • Components
• Before you start
  • Solution definition
  • Repositories scaffolding
• Development guidelines
  • Content architecture
  • Configuration management
  • Writing tests
  • Module update policy
  • Tooling
  • Dependency management
  • Development Workflow
  • Coding standards
  • Frontend development
  • CI And deployment workflow
  • Code reviews
  • Release workflow
• Templates
  • Issue template
  • Pull request template
• Development guides
  • Drupal
• Automated testing

documentation's Issues

D8 knowledge base topic: Caching

An article to explain how D8 uses caching:

• Cache tags
• Cache contexts
• Cache max age

"Frontend development" leads to 404

The "Frontend development" document link leads to 404.

https://github.com/openeuropa/documentation/blob/master/docs/development/frontend/index.md

Question: versioning policy + official installation guide not accurate

Dear OpenEuropa team.

Could you direct me to your policy for versioning of the Open Europa ecosystem,
or to a master composer file with compatible and stable library versions?

It seems to me that you include dependencies on active branches in stead of stable release versions, even when the top artifact is considered a stable release (e.g. OpenEurope Theme v 2.9.0).
I have a local environment, that is shared through docker with my team. Earlier this week, I ran the "composer update" command as I wanted to update the version of a few drupal core package (default-content, and others).
Unfortunately, this also pulled in the latest version of oe_content and oe_media, which depend on dev-master dependencies down the line.

This broke my installation. It seems to me that the only way to avoid this issue from a user's perspective is to never update the composer.lock file or external libraries once the deployment is working.

I am currently following the suggested approach for installation (using composer require) and am still running in to compatibility issues, as I am unable to start the oe_theme_news module due to missing internal dependencies.

Composer file for reference, created using 'composer require'.
I added the consolidation packages manually, as I was getting errors at installation time for missing dependencies.
composer_not_working.txt

When I run the installer without locally building the latest banch of oe_theme, and just rely on the
require approach you would use with other themes, this is how my deployment ends up looking:

Any help addressing this issue is appreciated.
For now I will direct my efforts to forking and building oe_theme myself as part of my setup script.

Kind regards,

Stijn

Wrong link for ci cd solution

https://github.com/openeuropa/documentation/blob/master/docs/starting/tooling.md#cicd-solutions

Docker for Mac does not need NFS anymore does it?

According to https://docs.docker.com/docker-for-mac/#resources regarding FILE SHARING there is no need for NFS as some folder path are shared already.

So I guess the section about MacOS can be removed in https://github.com/openeuropa/documentation/blob/master/docs/starting/tooling.md#using-docker-on-macos

For reference: NFS was introduced in https://docs.docker.com/docker-for-mac/release-notes/#docker-community-edition-18030-ce-mac59-2018-03-26

D8 Knowledge base topic: working with event listeners

Dead link for OE guidelines

Hello,

I am browsing https://github.com/openeuropa/documentation for contribution guidelines.
I follow "Contribution workflow" link to https://github.com/openeuropa/documentation/blob/master/docs/initiative/contribution-workflow.md
Then I follow "OpenEuropa contribution guidelines." which is a dead link