Comments (7)
@danielmewes, so far we have the Getting Started guide in the Horizon repo.
We need to add this to the docs repo.
from horizon-docs.
Oh the "Getting Started" guide is quite nice.
I think the original intention behind the "tutorial" was something a bit more extensive where we write a full application. That's probably going to be more work.
I think we should put the current "Getting Started" guide into the quickstart. It looks like quickstart used to be the same as the Getting Started guide, but the latter has since been extended?
from horizon-docs.
I'd like to check this with @chipotle though, since there might have been some different intentions behind these documents or things he has improved in the quickstart that aren't reflected in the Getting Started guide.
from horizon-docs.
They're meant to be similar documents, but I didn't intend to put the OAuth stuff in the QuickStart documentation, instead linking to the authentication document for that. Most of what's in Getting Started other than that should be in QuickStart already, although arranged differently and with some stylistic changes.
from horizon-docs.
It looks like only the "Getting started with Horizon client" section from https://github.com/rethinkdb/horizon/blob/next/GETTING-STARTED.md wasn't in the docs yet.
It is now at https://github.com/rethinkdb/horizon-docs/blob/master/getting-started.md
That's enough for the 1.0 launch.
I think we should still have a more extensive tutorial later.
from horizon-docs.
@segphault is working on a basic tutorial that covers permissions and building a basic app.
@segphault: do you think the [Getting started] guide would overlap with the outline for the tutorial you're writing? Could you post the outline you're planning?
from horizon-docs.
There are some differences in scope between the tutorial that I'm working on and the Getting Started guide. The tutorial will include:
- Building a social bookmark application with these features:
- Users can add/edit/remove their own bookmarks
- Users can share bookmarks into a public stream
- Unauthenticated users can see public bookmarks
- It uses the following Horizon capabilities:
- Authentication
- hasAuthToken
- currentUser
- authEndpoint redirect
- Permissions
- Templates and validators that do the following:
- Allow unauthenticated users to fetch public data
- Ensure private data is only accessible to its owner
- Allow users to update and delete their own data
- Templates and validators that do the following:
- Queries
- findAll with order/limit
- store
- replace
- remove
- Authentication
- Tutorial will additionally cover:
- Writing the schema.toml and applying it from the command line
- Using the auth methods and queries in a VueJS app
- The tutorial will not cover:
- Step-by-step walkthrough of installing horizon and using hz init
- Complete coverage of the relevant options in config.toml setup
- Steps for generating and configuring the OAuth provider token
The TL;DR is that the tutorial is an application-focused introduction to using Horizon with permissions and authentication. It doesn't cover the basic setup, which I think is better left for documentation.
from horizon-docs.
Related Issues (20)
- Upgrade docker-compose files to v2 of the docker-compose file spec HOT 8
- Document integration with specific frameworks (React etc.) HOT 2
- Users doc misleading
- cookbook entry: subscribing to changing data
- Horizon 2.0 docs checklist HOT 27
- Document `Collection.update`, `Collection.insert` and correct existing write commands
- Clarify client constructor host option
- .filter() listed twice in Observable's methods. HOT 1
- We need a guide on "Deploying Horizon"
- New page about Horizon client packaging HOT 2
- Section headers should be clickable to put the fragment in the URL path
- Document admin user requirement
- Permissions only mentions `.find` once but it isn't clear if using `.findAll` covers `.find`? HOT 2
- Auth documentation needs to show boilerplate on how to handle connections by unauth'd and auth'd users
- Embedding docs incorrectly uses `_reql_conn` as a property of the server module HOT 2
- Document how to use JWT generated using CLI
- horizon js can not access rethinkdb in port 28025 without --dev flag . Error : action not permitted .
- Docs at http://horizon.io/docs/auth/ don't say what callback URL to use HOT 8
- Include section in FAQ on why full ReQL queries aren't supported in Horizon
- Document .aggregate and .model HOT 9
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from horizon-docs.