Add a README file and document how to setup locally and start basic documentation.

Created on 27 November 2023, about 1 year ago
Updated 12 July 2024, 5 months ago

Problem/Motivation

As a community member contributing to this project, I require documentation for:

  • local spin up
  • content types and structure
  • user roles and best practices
  • deployment process
  • contribution process
  • managing la_* projects up- & downstream
  • setup for a new la_* instance & deployment pipeline
  • common workflows: e.g. database dump update process

Proposed resolution

Add a README.md file to the project.

Requirements
* PHP 8.2
* Install in language: en

local spin up
Get the code

git clone git@git.drupal.org:project/la_eu.git
cd la_eu

Optional install and configure DDEV: https://ddev.readthedocs.io/en/latest/users/install/ddev-installation/

ddev config --project-name=la-eu --project-type=drupal10 --docroot=docroot --php-version=8.2

Prefix any command with ddev if you use it.
Build the setup

composer install

Install the setup

drush si -y --account-name=admin --account-pass=admin

Import example content

drush en -y la_eu_default_content
drush pmu -y default_content

Launch the instance
drush browse or ddev launch

Remaining tasks

Create the README.md file. Give it structure and document.

Here is an example of how this could look like with mkdocs
https://la-eu-project-40fac56e136d10c865fd122936a7caf14314233b7c638d088....

📌 Task
Status

Fixed

Version

1.0

Component

Documentation

Created by

🇦🇹Austria jjchinquist Vienna, Austria

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.71.5 2024