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

Status Update - v4 Docs #2322

Open
niden opened this issue Jun 18, 2019 · 26 comments

Comments

@niden
Copy link
Member

commented Jun 18, 2019

WIP

Docs

  • annotations
  • application-cli
  • application
  • application-micro
  • controllers
  • cookies
  • db-layer
  • db-models-behaviors
  • db-models-cache
  • db-models-events
  • db-models
  • db-models-metadata
  • db-models-relationships
  • db-models-transactions
  • db-models-validation
  • db-odm
  • db-phql
  • debug
  • devtools
  • di
  • dispatcher
  • escaper
  • events
  • filter
  • flash
  • forms
  • http-request
  • image
  • installation
  • introduction
  • mvc
  • namespaces
  • performance
  • plugin
  • reproducible-tests
  • response
  • routing
  • session
  • tag
  • tutorial-basic
  • tutorial-invo
  • tutorial-rest
  • tutorial-vokuro
  • upgrade
  • use-case
  • validation
  • views
  • volt
  • webserver-setup

Completed/Reviewed

  • acl
  • assets
  • cache
  • coding-standard
  • collection
  • config
  • contributions
  • crypt
  • domain
  • environments-nanobox
  • generating-backtrace
  • helper
  • i18n
  • loader
  • logger
  • new-feature-request
  • new-pull-request
  • registry
  • reproducible-tests
  • request
  • security
  • sponsors
  • testing-environment
  • translate
  • url

Notes
We need to make sure that all issues in the cphalcon repository with the label "docs needed" are covered in our documentation.

@ruudboon

This comment has been minimized.

Copy link
Member

commented Jul 7, 2019

All checked doc's are below.

ACL

  • boolval consistently (pull)
  • Maybe add an example of the ACL firewall also.

ASSETS

CACHE
Perfect :D

ruudboon added a commit that referenced this issue Jul 7, 2019

Update assets.md
Typo fix #2322
This was referenced Jul 7, 2019

@niden niden closed this in #2337 Jul 7, 2019

niden added a commit that referenced this issue Jul 7, 2019

@niden niden reopened this Jul 7, 2019

@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 7, 2019

@ruudboon

ACL: Maybe add an example of the ACL firewall also.

I was going to add a page on its own for that but could very well add it to the same page. I guess we can leave this as is now, work on the new firewall page and then decide if we want to cross link them or include the Firewall in Acl

In the top of the page we sum the options, can we internal link this (For example to https://docs.phalconphp.com/4.0/en/assets#auto-versioning)

I have that in the API documentation. The reason I opted not to is because we have the left menu that does that and if we add the links at the top it pushes the content downwards which is not ideal.

@ruudboon

This comment has been minimized.

Copy link
Member

commented Jul 10, 2019

Coding standard looks good to me. Asset can also be marked done

@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 12, 2019

Completed Config

@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 12, 2019

Completed Security

@ruudboon

This comment has been minimized.

Copy link
Member

commented Jul 13, 2019

Reviewed collection. Not my favorite colors in the example but all clear and ready for production.

@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 13, 2019

@ruudboon LOL. Well it matches 1776....

Thanks for reviewing that.

@Arhell

This comment has been minimized.

Copy link
Member

commented Jul 14, 2019

Hi, #2345 sponsors update
will be like this
https://docs.phalconphp.com/3.4/en/sponsors

@ruudboon

This comment has been minimized.

Copy link
Member

commented Jul 14, 2019

I reviewed config. Dropped a pull for some small changes.
One thing that is a bit unclear to me is the start example. From the code examples I understand that getenv('APP_NAME') should hold "PHALCON". Maybe it's a better idea to just put strings there with the value.

@ruudboon

This comment has been minimized.

Copy link
Member

commented Jul 14, 2019

Contributions looks good to me.

@Arhell Arhell referenced this issue Jul 14, 2019
@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 14, 2019

Completed Url

@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 15, 2019

Completed i18n

@ruudboon

This comment has been minimized.

Copy link
Member

commented Jul 15, 2019

Verified

  • crypt (pull pending, love the luggage code key :D, we should add more. Like your moms phone-lock code :D. One thing about the key. Can we say something about the length of the key in the red box. Is there an optimal length?
  • domain (all good now)
  • environments-nanobox (text ok, should test installation)
  • backtrace (I think it's a good to explain something about crashes and explain a bit what a backtrace is. I will make an example of what I mean)
@ruudboon

This comment has been minimized.

Copy link
Member

commented Jul 15, 2019

Verified Helper
All good only would like to check reduceSlashes. What are the rules for accepting double slashes? I see that http://url won't change but we need to explain this a bit more. Will ftp://url work? And how about an url like //your.domain.com

Verified logger
Can we explain what will happen if one of the loggers fails when using multiple loggers. Would be cool if it could still write to the other loggers. But that's outside the scope. I do think we should describe what will happen.

new-feature-request
All good

new-pull-request
Can we add something that this is about the Phalcon source and we have different requirements for the docs?

registry
All good

reproducible-tests
All good

security
See pull
And end of document. Also in your views (Volt syntax). I think this is only the case with MVC or is this also available on micro if you setup volt?

testing-environment
All good

translate
All good

@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 15, 2019

And end of document. Also in your views (Volt syntax). I think this is only the case with MVC or is this also available on micro if you setup volt?

Yes so long as you set volt up it is there.

@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 15, 2019

All good only would like to check reduceSlashes. What are the rules for accepting double slashes? I see that http://url won't change but we need to explain this a bit more. Will ftp://url work? And how about an url like //your.domain.com

The schema slashes are left as they are:

echo Phalcon\Helper\Str::reduceSlashes("http://foo.bar///baz/buz");
http://foo.bar/baz/buz

The //something/somethingelse will not work since it is not a real URL.

ftp://something works

The regex is: preg_replace("#(?<!:)//+#", "/", text);

@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 15, 2019

All good only would like to check reduceSlashes. ....

Added more examples

Can we explain what will happen if one of the loggers fails when using multiple loggers. Would be cool if it could still write to the other loggers. But that's outside the scope. I do think we should describe what will happen.

Added a small callout for this.

@ruudboon

This comment has been minimized.

Copy link
Member

commented Jul 16, 2019

i18n
Reviewed i18n, nothing incorrect but pure PHP examples. Wondering if we can make examples that really involves some Phalcon. Maybe in combination with volt?

url
Just one typo (see pull) rest is perfect

@ruudboon ruudboon referenced this issue Jul 16, 2019
@niden

This comment has been minimized.

Copy link
Member Author

commented Jul 16, 2019

Reviewed i18n, nothing incorrect but pure PHP examples. Wondering if we can make examples that really involves some Phalcon. Maybe in combination with volt?

Well there is not much to add there since this is all PHP functionality, Phalcon does not help anywhere there. Honestly this article has been written years ago and I could never see the real reason behind it since it is just a discussion about the intl extension

@ruudboon

This comment has been minimized.

Copy link
Member

commented Jul 20, 2019

@niden I already scanned some docs. Hopefully it can be at help. We need to verify all the code examples to match v4 but besides that some points.

Annotations
In general it looks good to me.

  • An example of annotations with ACL would be a nice add

Application-cli
Some small things we can look at.

  • Update title, looks like a tutorial now.
  • A minimal structure of a CLI application will look like this: // can look like this. You can also do it in 1 file
  • Add example of shebang (#!/usr/bin/env php)
  • Tasks in chain is unclear to me

Application
In general ok.

  • Update code examples
  • Add some links to api like dispatcher etc
  • No mention of routing at all

Application-micro
Looks good to me

  • Small applications doesn’t feel as the right term. We can have a huge complex api but you still want to use micro in that case. More like feature opt-in kinda thing
  • Add acl firewall here?

Controllers
Looks good

  • Add: With suffix Action in the sentence "By default all public methods with suffix Action on a controller map to actions and are accessible by a URL"

Cookies
Looks good

  • It looks like it’s only tracking the cookies that are set. I assume it also read the the cookies from the request and store them in response?

DB-Layer
Looks good

  • Can we mention the incubator?
@niden

This comment has been minimized.

Copy link
Member Author

commented Aug 8, 2019

Loader completed

@ruudboon

This comment has been minimized.

Copy link
Member

commented Aug 8, 2019

Loader reviewed! All good. thnx

@diplopito

This comment has been minimized.

Copy link
Contributor

commented Aug 19, 2019

Since Phalcon\Plugin got its own namespace, it could be useful to document it as well.

@ruudboon

This comment has been minimized.

Copy link
Member

commented Aug 19, 2019

Thnx @diplopito Added it to the list

@ruudboon

This comment has been minimized.

Copy link
Member

commented Aug 19, 2019

As discussed on Discord @diplopito will have a look at:

  • Annotations
  • Application-cli
  • Application
  • Application-micro
  • Controllers
  • Cookies
  • DB-Layer

Thnx!

This was referenced Aug 21, 2019
@ruudboon

This comment has been minimized.

Copy link
Member

commented Aug 21, 2019

Reviewed request.md in general it looks great. Got some small questions.

In the beginnen we mention there are 4 (should be 5, see pull) for retrieving data. But you can also use getFilteredPost(), getFilteredPut(), getFilteredQuery(). Should we mention this there also?
How about the $_FILES maybe introduce something here also?

getClientAddress(): Gets most possible client IPv4 Address. Only v4? What will happen if it's a v6 request and how to get it?

Uploading Files
Is this the correct name? We're talking about the request. Was expecting something like Handeling file uploads. For 4.1 it would be nice if we could extend this file uploading a bit and give some filtering options here also. Like extension/mime check etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
You can’t perform that action at this time.