Getting started and other documentation issues
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- html
- Domain
- documentation
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.
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.
- Dominant language
- HTML
- Stars
- 11
- Forks
- 30
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ebean-orm/website-source
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
ebean-orm/website-source#62 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
ebean-orm/website-source#39 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
ebean-orm/website-source#13 ·
All issues in ebean-orm/website-source
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
Git-it-App/git-it-electron#1047 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
neondatabase/website#5944 ·
-
📕documentation
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
db-ux-design-system/core-web#8239 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
libsdl-org/sdlwiki#1008 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100