search

trailsjs / doc

:books: Trails.js Documentation
Other
18 stars 10 forks source link

Chore v1.0 : Implement Concepts #5

Closed maissani closed 7 years ago

maissani commented 8 years ago

Feature Concepts

Who can contribute?

Any people can contribute on docs.

What's needed

(This issue will be updated each time something is finish or created) The following list describe what's our needs for the V1.0 of the docs:

One PR for each features because of unobstrusive contributing and fastest releasing docs. Double check, you have to Assignee your PR to someone, docs has to be always double or sometimes triple check.

The Currently in progress status

The developper is currently working on it, realeases has to pass the double verification to be merged.

The Locked status

When docs are merged and wait for beeing reopened cause something could be missing.

jaumard commented 8 years ago

@trailsjs/maintainers feel free to pick one and help with this as you have the best vision of the framework :)

konstantinzolotarev commented 8 years ago

I see some problems with Models/ORM because there are several totally different ORM trailpacks that have different way of models description. And lot of other parts of trails has framework/library specific configs and features. We might be need to create some basic description and list of available trailpacks with detailed docs per trailpack.

jaumard commented 8 years ago

@konstantinzolotarev I agree with you. Docs per trailpack need to be where ? In this repo or each trailpack should have his own docs folder ?

Also for policies https://github.com/trailsjs/trails-docs/blob/master/concepts/policies/README.md we put Hapi and Express version, do you think it's correct (Controller will work like this too) or it will be better to put an Introduction and add only a link to the specific trailpacks instead ?

konstantinzolotarev commented 8 years ago

@jaumard I'd prefer each trailpack has it's own docs folder. We will be able to load in somewhere in docs website. And maintainers of trailpack will be able to write docs without need to change repo and search something.

jaumard commented 8 years ago

@konstantinzolotarev sounds good for me :) we will change this. Trailpack docs folder must have same file structure, something like

konstantinzolotarev commented 8 years ago

@jaumard I think we need to create some sample for this.

jaumard commented 8 years ago

@konstantinzolotarev also maybe generator-trailpack can add a command to generate the folder structure of trailpack depends of they extends trailpack trailpack-webserver or trailpack-datastore

konstantinzolotarev commented 8 years ago

@jaumard sorry was without internet for several days. I think it's good idea could you create issue there ? I'll do tomorrow

jaumard commented 8 years ago

@konstantinzolotarev no problem :) here it is https://github.com/trailsjs/generator-trailpack/issues/9

maissani commented 8 years ago

Hi @trailsjs/maintainers,

Now part of docs that belongs to be trailpack-specific belongs to be in respective trailpacks.

As you can see in https://github.com/trailsjs/trailpack-express you can see that /docs/concepts/policies who contains policies docs for express, A small reference to this docs are done there : https://github.com/trailsjs/trails-docs/tree/master/concepts/policies This aim the ability to auto-generate docs website from github docs as everybody nows there.

Docs is realy helpfull for people that try do dive in trailsJS Framework and mandatory to get the best developper exprerience.

That's why, i'm asking for help, and any kind of help, from validating docs to writing them.

Best Regards, Mehdi AISSANI

jaumard commented 8 years ago

What is the purpose of Tags section ? https://github.com/trailsjs/trails-docs/tree/master/anatomy/trailsProject/api#tags don't know what to write there...

scott-wyatt commented 8 years ago

@maissani I will try and contribute to this.

jaumard commented 8 years ago

@maissani @scott-wyatt I working on the anatomy

jaumard commented 8 years ago

@maissani what is Dependency Injection for Trails ? For me ORM and Models are duplicate part Config and Environment are one part for me (or env sub part of config) Modularity is part of Trailpacks, a full part looks to much ^^