These are chat archives for PerfectlySoft/PerfectDocs

19th
Jul 2016
Jonathan Guthrie
@iamjono
Jul 19 2016 16:05
BTW @rymcol I’ve added the CLA on PerfectDocs :)
thanks for pointing it out
Ryan Collins
@rymcol
Jul 19 2016 16:09
No problem
Jonathan Guthrie
@iamjono
Jul 19 2016 17:09
looking now...
Kyle, this is awesome
Tim Taplin
@taplin
Jul 19 2016 17:13
+1
Kyle Jessup
@kjessup
Jul 19 2016 18:46
Added a few more doc sectons to the TOC. Sorry :)
Jonathan Guthrie
@iamjono
Jul 19 2016 18:46
no need to apologize! I have a few more to add as well
can’t see them?
nm, i see them now
Ryan Collins
@rymcol
Jul 19 2016 18:47
but have you finished writing the new sections you’ve added yet?????
:D
Kyle Jessup
@kjessup
Jul 19 2016 18:47
filters and networking
Jonathan Guthrie
@iamjono
Jul 19 2016 20:31
PostgreSQL docs up, if anyone would like to vet them…
Tim Taplin
@taplin
Jul 19 2016 22:18
Jono, I’ve added a quickstart example for the Mysql readme. Please review.
I’m thinking about potentially changing the error response.
Ryan Collins
@rymcol
Jul 19 2016 22:21
@taplin if you do, please let me know so I can change it in the Docs guide
Tim Taplin
@taplin
Jul 19 2016 22:22
@rymcol I’m referring to changing how I handle it in my quickstart code, not planning on changing the MySQL functionality.
Ryan Collins
@rymcol
Jul 19 2016 22:23
k
Tim Taplin
@taplin
Jul 19 2016 22:24
I’m just returning empty along with a logged error message, and I’m thinking that I should likely do a throw error
Ryan Collins
@rymcol
Jul 19 2016 22:24
Gotcha
Tim Taplin
@taplin
Jul 19 2016 22:25
I would appreciate your input as well, ryan
Ryan Collins
@rymcol
Jul 19 2016 22:25
I’ll take a look
Tim Taplin
@taplin
Jul 19 2016 22:25
by the time I come up with several more quoickstarts, I might have a format that I actually like… its a work in progress
Ryan Collins
@rymcol
Jul 19 2016 22:27
Lol, I know the feeling
Jonathan Guthrie
@iamjono
Jul 19 2016 22:27
docs for me are the same
Ryan Collins
@rymcol
Jul 19 2016 22:30
@taplin that’s really in depth and looks good
For me it brings up a few questions
The part about setting up the basic project and clonging PerfectTemplate
will probably be a part of a lot of quick starts
it might make sense to move something like that to the PerfectTemplate readme, then link to it there
That way if the template changes, it’s readme changes, and there’s no scrabling to update x other guides
Also, we were chatting a while ago about a standard config file for things like IP, Port, Database Info, etc.. and were debating the value of something like a plist for it. I realized here that you do your setup much differently than I do (I make a struct called config and put all my connection info in that). Which makes me think it might be a good time to think about standardizing that, so the documentation will be more digestable for people investing time in the platform.
Ryan Collins
@rymcol
Jul 19 2016 22:35
But that’s a big change, so it should probably be discussed first.
Tim Taplin
@taplin
Jul 19 2016 22:48
I do the same thing with my config info, but did not think that type of default should be forced on a quickstart setup
I would welcome some discussion on what the best method is to store and include credentials and settings relating to database, external api’s, and other sensitive info for our server side projects.
I try to keep the credential setup to a minimum, and store as much as possible in a datasource
I think that we could potentially link to a readme on the PerfectTemplate, although I dont tend to use it for anything myself
Kyle Jessup
@kjessup
Jul 19 2016 22:57
Added routing, if anyone wants to give it a check https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/routing.md
Jonathan Guthrie
@iamjono
Jul 19 2016 22:58
reading now/...