ebean-orm / ebean-orm/website-source

Getting started and other documentation issues

Open
#37 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
11
Forks
30
PR merge metrics
No merged PRs in 30d

Description

I'm going through the "Getting Started" section of the documentation and all it really does is configure my build.gradle. https://ebean.io/docs/getting-started/gradle

Typically a Getting Started either does a very short tutorial or it links to a tutorial.

I'm banging my head on the table just trying to figure out:

  • What is ebean.mf for?
  • Where do I define my DB conenction(s)?

Maybe the issue is just the layout of the website? When I click a link on https://ebean.io/docs/ it sometimes takes me to a page with more subpages, sometimes not. There doesn't appear to be a master table of contents. Furthermore, as I navigate through the docs, sometimes the right sidebar links change without warning; introducing even more pages or removing some.

Any help would be greatly appreciated.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Getting Started section at ebean.io/docs/getting-started/gradle and inspect how it references build.gradle and ebean.mf. Trace the documentation navigation and sidebar structure to identify where a master table of contents and tutorial guidance belong. Done means the purpose of ebean.mf, database connection setup, and a coherent path through the documentation are clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.