Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

get the anatomy guide started #15

Merged
merged 3 commits into from
Jul 22, 2016
Merged

Conversation

connor11528
Copy link
Contributor

Here is the basic structure. We can for sure dig deeper here but something is better than nothing!

Here is the basic structure. We can for sure dig deeper here but something is better than nothing!
@connor11528
Copy link
Contributor Author

Also could add these notes from @jaumard

http://blog.jaumard.com/en/2016/01/05/getting-started-with-trails/

env : Config file that overrides the default per environment, you can change the entire config for your production environment
database : Information about your database: type, migration strategy, et cetera.
footprints : Options for your REST API: add a prefix, enable/disable footprint, et cetera.
i18n : Configuration for multi language support: set default language and translations.
locales : Folder in which to put all translation files
log : Logger options for your project. Uses winston by default.
main : Allow you to enable/disable trailpacks.*
policies : Allow you to map your policies with controllers.
routes : Allows you to map your controller’s functions with routes.
session : Options for managing sessions: strategies, cookies, web tokens, et cetera.
views : Allow you to configure your template engine.
web : Options for web server, like port.
webpack : Configuration for building assets, it’s a default webpack configuration (http://webpack.github.io/docs/configuration.html)

@maissani
Copy link
Member

@connor11528 , i agree with your point of view.

@maissani maissani self-assigned this Jul 21, 2016
@maissani
Copy link
Member

Can you add an ExampleModel.js, examplepolicy in the list :)
📁

@connor11528
Copy link
Contributor Author

Okay added in notes. Is that closer? Added exampleModel and examplePolicy

@maissani
Copy link
Member

Why did you add notes ? Theses info shouldn't be there , this is my opinion.
Don't warp your directory tree because i couldn't implement direct link to anatomy files with when warped between codeblock.

@maissani
Copy link
Member

Models and Policies that all and i ll accept the PR 👍 Then i will implement links

@maissani
Copy link
Member

Your information is usefull but i think this should be under respective directories.

@connor11528
Copy link
Contributor Author

Okay I'm a trails n00b and don't know exactly how models and policies work. Deleted the notes

@maissani
Copy link
Member

Your are not a noob , there is no noob there, there is just code lovers.
Your Notes has to been under config folder of trails Anatomy.
The list that you provide is just a simple Sumary that contains links forwarding to docs and files respectively.

@maissani maissani merged commit 686e382 into trailsjs:master Jul 22, 2016
@maissani
Copy link
Member

@connor11528 If you can continue , you will be welcome. :) I made some change with your declaration to get everything more prety and more readable. I also give an example of linking ( api ) .

@connor11528
Copy link
Contributor Author

awesome great news. We can build out this documentation for sure! It's an asset for the community

have a great day

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants