apache / apache/grails-core

Documentation in GORM developer guide not aligned with current practices

Open
#14,604 0 comments 0 reactions 0 assignees View on GitHub
relates-to: gorm
Dominant language
Groovy
Stars
2.9k
Forks
975
Avg merge
1d 22h
Merged PRs (30d)
92

Description

I've looked at the gorm developer guide, and it points to creating your new project as a sub within data store project and build out from there. However the latest download doesn't include neo4j, mongo etc which are separate top level projects in there own rights.

This independent approach and how to reference dependencies on the core project is not 'easy' to see.

as a relative novice, id like to be able to create a new implementation in a clear best practice build approach.

Having an empty project template with the core - which has a simple basic gradle build and framework would help new developers get up to speed more quickly when starting out

I'm struggling with just where to start at the moment

Any guidance and updates to developer guide to reflect latest approaches would help alot i think and reduce time and effort when getting started on new database subproject for GORM.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the GORM developer guide and the current repository layout, including the separate Neo4j and MongoDB projects. Done means the guide explains the current top-level project structure and core dependency references, and provides or describes an empty project template with a basic Gradle build.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy, mongodb, neo4j
Domain
build-system, developer-experience, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.