yahoo/elide-doc

The documentation for the Elide project

elide.io

Doc site for Elide built with Jekyll

Getting started

1. install bundler gem install bundler
2. checkout gh-pages git checkout gh-pages
3. install bundle gems: bundle install
4. start jekyll bundle exec jekyll serve
5. visit page at http://localhost:4000/
6. edit the pages you care about
7. submit a PR so the rest of the world can see your helpful information

elide-doc's Issues

Fix Broken Links

Status	URL	Source link text
403 Forbidden	https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-test	Spring Boot Test Starter
404 Not Found	https://github.com/yahoo/elide/blob/master/elide-swagger/src/main/java/com/yahoo/elide/contrib/swagger/resources/DocEndpoint.java	provided JAX-RS Endpoint
404 Not Found	https://github.com/yahoo/elide/blob/master/elide-core/src/main/java/com/yahoo/elide/utils/coerce/converters/ISO8601DateSerde.java	IS8601 Serde
404 Not Found	https://github.com/yahoo/elide/blob/master/elide-core/src/main/java/com/yahoo/elide/utils/coerce/converters/EpochToDateConverter.java	Epoch Serde
404 Not Found	https://github.com/yahoo/elide/blob/master/elide-contrib/elide-test-helpers/src/main/java/com/yahoo/elide/contrib/testhelpers/graphql/GraphQLDSL.java	here
404 Not Found	https://github.com/yahoo/elide/blob/master/elide-contrib/elide-swagger/src/main/java/com/yahoo/elide/contrib/swagger/resources/DocEndpoint.java	provided JAX-RS Endpoint
404 Not Found	https://github.com/yahoo/elide/tree/master/elide-contrib/elide-test-helpers	elide-test-helpers
404 Not Found	https://github.com/yahoo/elide/blob/master/elide-contrib/elide-test-helpers/src/main/java/com/yahoo/elide/contrib/testhelpers/jsonapi/JsonApiDSL.java	here
404 Not Found	https://elide.io/pages/guide/v{{ page.version }}/03-security.html	security section
404 Not Found	https://elide.io/pages/guide/v5/06-datatstores.html	data store
404 Not Found	https://elide.io/pages/guide/v6/06-datatstores.html	data store
404 Not Found	https://elide.io/pages/guide/v4/06-datatstores.html	data store
404 Not Found	https://elide.io/pages/guide/v5/(/pages/guide/v5/11.5-asyncapi.html)	asynchronous API

Status URL Source link text
403 Forbidden https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-test Spring Boot Test Starter
404 Not Found https://github.com/yahoo/elide/blob/master/elide-swagger/src/main/java/com/yahoo/elide/contrib/swagger/resources/DocEndpoint.java provided JAX-RS Endpoint
404 Not Found https://github.com/yahoo/elide/blob/master/elide-core/src/main/java/com/yahoo/elide/utils/coerce/converters/ISO8601DateSerde.java IS8601 Serde
404 Not Found https://github.com/yahoo/elide/blob/master/elide-core/src/main/java/com/yahoo/elide/utils/coerce/converters/EpochToDateConverter.java Epoch Serde
404 Not Found https://github.com/yahoo/elide/blob/master/elide-contrib/elide-test-helpers/src/main/java/com/yahoo/elide/contrib/testhelpers/graphql/GraphQLDSL.java here
404 Not Found https://github.com/yahoo/elide/blob/master/elide-contrib/elide-swagger/src/main/java/com/yahoo/elide/contrib/swagger/resources/DocEndpoint.java provided JAX-RS Endpoint
404 Not Found https://github.com/yahoo/elide/tree/master/elide-contrib/elide-test-helpers elide-test-helpers
404 Not Found https://github.com/yahoo/elide/blob/master/elide-contrib/elide-test-helpers/src/main/java/com/yahoo/elide/contrib/testhelpers/jsonapi/JsonApiDSL.java here
404 Not Found https://elide.io/pages/guide/v{{ page.version }}/03-security.html security section
404 Not Found https://elide.io/pages/guide/v5/06-datatstores.html data store
404 Not Found https://elide.io/pages/guide/v6/06-datatstores.html data store
404 Not Found https://elide.io/pages/guide/v4/06-datatstores.html data store
404 Not Found https://elide.io/pages/guide/v5/(/pages/guide/v5/11.5-asyncapi.html) asynchronous API

Clarify elide.swagger.version and how it relates to versioning Elide models

See issue (3) from https://spectrum.chat/elide/general/elide-spring-boot-starter-problem~b26aa2bd-372f-420e-89d8-dbc653b1dbb5 for context.

Add documentation about custom validation and error handling

The concept about custom hooks needs more information about how to add custom errors etc.

I found the CustomErrorException and the ErrorObjectsBuilder eventually, but this should be part of the docs, maybe together with some best practices?

Need better documentation about type coercion

Link is gone

In http://elide.io/pages/guide/01-start.html#spin-up-the-api , link for "demo setup script" is not working

Should include OpenGraph/Twitter meta info for link previews

See

• http://ogp.me/
• https://dev.twitter.com/cards/getting-started

Elide Documentation bug

When describing how to build a data model, the code defines Book as being rootable, but the explanation claims Author is rootable.

Review and Update links in Elide 5 documentation before release.

Review and Update links in Elide 5 documentation before Elide 5 release and merge to master.

Need to Document BridgeableStore

The bridgeable store remains undocumented today. This is unfortunate because it enables Elide to coordinate across datastores with compound models (i.e. a hibernate persisted-model can have a relationship in Elide to a redis-persisted model, for instance).

We need to document the what, why, and how. Fortunately, the interface itself is well-documented: https://github.com/yahoo/elide/blob/master/elide-datastore/elide-datastore-multiplex/src/main/java/com/yahoo/elide/datastores/multiplex/BridgeableTransaction.java

Create How To / Advanced Topics Doc Section

We should doc advanced topics such as:

• Nested JSON
• Localization
• SerDe