OData / OData/odataorg.github.io

New intro text on OData Why and What?

Open
#173 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hi,

I was asked to give an introductionary course on OData. I was please to see the new updated OData tutorals, e.g. Odata in 6 steps. Compliments for who wrote those. This explains the how beautiful.

What is still missing on the OData site is a nice introductionary text.
I something like that planned already? There are some great bits and peaces that can be googled but that go in to much detail or are outdated.

IMHO it should describe:

  1. The Why
  2. The Where (Name a few open and commercial services that use it).
  3. The What (without going into to much specification details but highlight the good parts:
    a. 'JDBC for the web;
    b.being typed via the schema
    c. CRUD
    d. navigating down
    e. SELECT, FILTER
    f. paging top/skip
  4. Depending on the audience it can refer to LINQ, Java Streams and or the list monad (without flatmap).
  5. Compare to Swagger and Facebook graph

I think the following is to much detail already:
5. Where the EDM comes from and why does the OData type system looks so much like the CLRs.

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 by reviewing the current OData tutorials, especially OData in 6 steps, and the existing introductory material on the site. Define the audience and publication location, then draft an introduction covering why and where OData is used, its core concepts and operations, and concise comparisons with LINQ, Java Streams, Swagger, and Facebook Graph.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.