Skip to content

Added info from the 'Codeception for Symfony' page #98

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

Merged
merged 1 commit into from
Mar 16, 2021

Conversation

ThomasLandauer
Copy link
Member

I'd like to drop all those pages completely:

I'm starting with Symfony (to show it's possible), and hopefully can motivate others to do the same for the other frameworks :-)

Reasons:

So what I did is: I copied the "Features" list from https://codeception.com/for/symfony into the module page - and that's it! The rest of https://codeception.com/for/symfony has (a) nothing to do with Symfony (e.g. the shown configuration of "Acceptance Testing"), or (b) is explained elsewhere (e.g. BDD).

Questions:

So if you agree, I'll go ahead and delete https://github.com/Codeception/codeception.github.com/blob/master/for/symfony.md. If possible, the URL should be redirected to the module page.

BTW: What is https://github.com/Codeception/codeception.github.com/blob/master/for/zend-framework.md%7E ?

Questions:
* By "Symfony Crawler" you mean "DomCrawler"?
* How does this work: "Symfony Router can be cached between requests to speed up testing"?
* I'm not 100% sure about the "API Tests" header, so please double-check if anything important from https://codeception.com/for/symfony#api-tests is missing at https://codeception.com/docs/10-APITesting#REST-API
@TavoNiievez
Copy link
Member

both Naktibalda and DavertMik have previously mentioned that they prefer to have the documentation and source code in one place, it's more likely to be up-to-date and in-sync that way, so you've got my 👍🏾 too.

By "Symfony Crawler" you mean "DomCrawler"? (double-check the link I added)

Yes. Your link is ok.

How does this work: "Symfony Router can be cached between requests to speed up testing"?

This is a very good question, in fact, for me that question could be an issue, since there is no documentation on how $I->invalidateCachedRouter() works or when exactly I should use it (neither does it have any test or example).

Here:

* * cache_router: 'false' - enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)

there is even reference to an article where optimizations are made in Sylius, but it is not very clear exactly how this solution:

	if ($this->config['cache_router'] === true) {
		$this->persistPermanentService('router');
	}

was inferred.

@Naktibalda
Copy link
Member

I think that For page was supposed to be more of a marketing piece than technical reference.

Zend Framework page has never been finished.

@ThomasLandauer
Copy link
Member Author

ThomasLandauer commented Mar 14, 2021

Well, OK, if everybody agrees, then let's go! :-)

Steps:

  1. Merge this.
  2. Redirect the URL https://codeception.com/for/symfony to the module page. Or is this configured at some place where I can send a PR?
  3. Delete the page from the repo (I can send a PR for this).

@TavoNiievez about the cache_router: I don't know anything about this. But in any case, this question shouldn't block this PR.

BTW: Just noticing that I already suggested to merge those pages some 4 years ago... ;-) Codeception/Codeception#4243 (comment)

@TavoNiievez
Copy link
Member

TavoNiievez commented Mar 15, 2021

TavoNiievez about the cache_router: I don't know anything about this. But in any case, this question shouldn't block this PR.

@ThomasLandauer I only answered your question, I agree that it is not an impediment for this PR.

I can't help with step 2, and those steps certainly make sense if all are done. For that reason I'll not be the one who merges this.

@Naktibalda
Copy link
Member

For step 2, add HTML redirection tag or javascript script to https://github.com/Codeception/codeception.github.com/blob/master/for/symfony.md

Related change would be to remove Symfony from Use Cases dropdown in https://codeception.com/
https://github.com/Codeception/codeception.github.com/blob/master/_includes/for.html

ThomasLandauer added a commit to ThomasLandauer/codeception.github.com that referenced this pull request Mar 16, 2021
See Codeception/module-symfony#98 (comment)
I'm not sure if `<meta>` really works here, but let's see :-)
ThomasLandauer added a commit to ThomasLandauer/codeception.github.com that referenced this pull request Mar 16, 2021
@ThomasLandauer
Copy link
Member Author

Please merge this PR now - the information should be present on Symfony Module page anyway - no matter how far the "deletion process" of the "use cases" dropdown already is...

@ThomasLandauer
Copy link
Member Author

What about https://codeception.com/for/joomla ? At first sight, most stuff is explained at https://github.com/joomla-projects/joomla-browser anyway. We could add a "CMS" header at https://codeception.com/docs/03-AcceptanceTests and collect everything there?
Same is probably true for https://codeception.com/for/wordpress
Should I ask the maintainers?

@TavoNiievez TavoNiievez changed the title Dropping "Codeception for" (i.e. button "use cases") part 1: Symfony Added info from the 'Codeception for Symfony' page Mar 16, 2021
@TavoNiievez TavoNiievez merged commit 7635356 into Codeception:master Mar 16, 2021
@TavoNiievez TavoNiievez added this to the 2.0.1 milestone Mar 16, 2021
@ThomasLandauer ThomasLandauer deleted the patch-4 branch March 16, 2021 19:24
@Naktibalda
Copy link
Member

A problem with adding more information to 03-AcceptanceTests or other numbered documentation pages is that these pages are already very long, so you are effectively burying these links and making AcceptanceTests page even more difficult to read.

There are links to joomla-browser and wp-browser in Addons page: https://codeception.com/addons

I think that the point of adding Wordpress and Joomla pages to separate top level menu was to highlight that Codeception works with these popular framework.

@ThomasLandauer
Copy link
Member Author

ThomasLandauer commented Mar 25, 2021

Yes, indeed :-) I already suggested to shorten them Codeception/Codeception#4394 - but that's quite some work :-)

Anyway, what can we do at short notice?

  • "burying" is indeed the right term, but this also applies to the "use cases" dropdown we're talking about ;-) So where needs really important stuff to be shown? => At the homepage! And - lo and behold - Wordpress and Joomla are already there :-) (see below for details).
  • After thinking some more about it: Let's not make the same mistake again, and "copy" the same content to 7 different pages (of which 6½ get outdated by the time :-) So in this case: Mention it at a prominent place (i.e. home page - done), but for details refer to their own websites. => See Adding redirect to wp-browser codeception.github.com#483 and Adding redirect to Joomla Browser codeception.github.com#484

Suggestions for the home page https://codeception.com/ (could be moved into a separate issue)

  • Shorten the gray <div>, to make the next section ("Benefits_") rise up higher. I almost missed this, since I didn't scroll down at the beginning...
  • General question: Which message are you sending out to Drupal users if you keep repeating "WordPress" and "Joomla" over and over? In other words: Are those WordPress and Joomla addons really adding something substantial, or just one or two convenience functions? I guess the correct message is not "Codeception works with WordPress and Joomla", but rather: "Codeception works with any CMS. For WordPress and Joomla there's an addon to make it even easier/better."
  • It the frameworks "card" (bottom) replace all links leading to "for"-pages to the module page. For WordPress and Joomla link directly to their GitHub repo.
  • Those "cards" and the "Framework_Testing" block (in the middle) are not in sync (e.g. Zend Framework missing), and some are missing completely (e.g. Laminas :-)

Where is this generated? Can I send a PR?

BTW: WordPress is listed twice at https://codeception.com/addons - which one is better and which one should go?

@DavertMik
Copy link
Member

@ThomasLandauer codeception for symfony and codeception for laravel pages exist mostly for maketing reasons. They are not really docs.
I am against removing them without any good alternative.

If you know how to bring more Symfony/Laravel users into Codeception - the ideas are appreciated.

@TavoNiievez TavoNiievez modified the milestones: 2.0.1, 2.0.0 Mar 28, 2021
DavertMik pushed a commit to Codeception/codeception.github.com that referenced this pull request Apr 23, 2021
* Adding redirect to Joomla Browser

See Codeception/module-symfony#98 (comment)

* Update for.html
DavertMik pushed a commit to Codeception/codeception.github.com that referenced this pull request Apr 23, 2021
* Adding redirect to wp-browser

See Codeception/module-symfony#98 (comment)

* Update for.html
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.

4 participants