Fix the current php code example(s) in "Implementing Single Sign on" about spid-tech-docs HOT 5 CLOSED

Hi! Thanks for the feedback.

I think we should strive for the users to be able to just copy-n-paste the shown solution.

Did you check out the working example? No need to copy and paste when you can git clone :-)

We didn't include a complete example, because we're linking to it instead. Looks like that link could be more prominently placed.

Would you mind taking a look at the working example, and see if that helps any? First of all, see if you can find it now that you know it's there. :-)

from spid-tech-docs.

Hi,

yes I have the sdk checked out. But if you install it via composer you don't get the example files. Even if the working example is simpler I think the guide step for step tutorial should include working code that one may just copy to their own project.

I had no problems fixing the issues and I think most php devs would not have that kind of issue, but if you're trying to implement it in your own project I think the best way is to have a simple and working step-to-step solution that the user can just copy when reading the tutorial.

My hypothesis is that it's way easier to follow a tutorial where every step is explained than rather look at a whole solution and try to figure out what one needs. Anyway, great guide but I think these additions will make it even better :)

from spid-tech-docs.

I'm not sure I understand.

The guide and the working example work in lock step. The guide explains the contents of the working example.

yes I have the sdk checked out.

I'm not talking about the SDK, but the working example.

from spid-tech-docs.

Oh I thought the working examples were refering to the examples folder in the sdk repo. 👍

But if the code is finished, why not just include the requires and so on in the code examples so developers can just copy-n-paste along with the tutorial? :)

from spid-tech-docs.

Oh I thought the working examples were refering to the examples folder in the sdk repo

Sounds like a good reason to move those examples out of the SDK.

But if the code is finished, why not just include the requires and so on in the code examples so developers can just copy-n-paste along with the tutorial? :)

To avoid duplicating the entirety of the working examples repo in the guides. It's a balancing act of clarity and brevity.

Maybe the current article doesn't balance it good enough, but I don't think the solution is to inline the entire example repo. Which is what we would have to do, since the working examples are minimal (ie, no extra fluff).

from spid-tech-docs.