wintercms / docs Goto Github PK

Note: For a list of all events available in Winter CMS itself, see the api documentation.

^ https://wintercms.com/docs/api/translator/beforeresolve link in https://github.com/wintercms/docs/blob/main/events-introduction.md returns 404 error, probably should be replaced with https://wintercms.com/docs/api/ or https://wintercms.com/docs/api/develop/

Currently, the search function is returning an SQL error:

I do not know what is causing this, but in any case something must have gone very wrong to display an SQL error in production.

The other endpoints for Docs, Markup and UI are working fine.

Take a look at width of first column of table.

Page: https://wintercms.com/docs/themes/development#theme-information

Google Chrome Browser:

Looking at Snowboard's winter.mix.js file, it is polyfilling only the last 2 versions instead of 4 like the docs mention supporting.
https://github.com/wintercms/winter/blob/cdd2f3833ae06f26d347e9c23626a9cbe223e277/modules/system/assets/js/snowboard/winter.mix.js#L21

On some docs pages, in text columned-list shortcuts don't work.
The three pages where I find the issue for now :

https://wintercms.com/docs/v1.2/docs/services/helpers top shortcuts
https://wintercms.com/docs/v1.2/docs/services/validation#available-validation-rules
https://wintercms.com/docs/v1.2/docs/services/collections#available-methods

For the Helpers top shortcuts, anchors need to be updated to remove "_".

For Validation (available validation rules) and Collections (available methods), the corresponding anchors doesn't exists in the rendered page.

I was just trying queueing closure according to the documentation, but falling in an "Closure object cannot have properties" error.
After a quick search, it look like Laravel dind't even support queueing closure since v5.3.0 release note.

As a user I want to be able to search the docs.

Current behaviour

• I enter a search term into the search box
• the TOC gets filtered by the search term

Expected behaviour

• I enter a search term into the search box
• I get a list of search results either below the search box (autocomplete) or in the main content area

Hi! I think, the manual for nginx should be updated in order to allow execution of install.php and other /install scripts.

On this page

https://wintercms.com/docs/v1.2/docs/setup/upgrade-guide#laravel-packages

It mentions that
"Unit testing should now be conducted using the php artisan winter:test command, as opposed to running unit tests directly on phpunit. This ensures that the correct bootstrap is used, as well as the necessary environment configuration is created."

On this page
https://wintercms.com/docs/v1.2/docs/console/utilities

It documents the winter:test command in depth

however on this page
"https://wintercms.com/docs/v1.2/docs/plugin/unit-testing"

The fact that you are now supposed to use winter:test instead of phpunit is not mentioned.

I think it should be mentioned on the 3rd page because that is the one which appears in the left hand menu, it is the one that explains how to setup unit tests in winter, is the one that appears in google ( for me anyway ), and is the closest thing to a direct piece of documentation for unit testing in Winter.
yet it makes no mention of the fact that you must use winter:test to run tests

Aditionally running 'phpunit' when using "\System\Tests\Bootstrap\TestCase" does indeed cause an error but you only get an error message if specific settings are turned on in php.ini, even with it turned on the error only tells you that "\System\Tests\Bootstrap\TestCase" could not be found which is not at all helpful.

the first page is a upgrade guide and the second page is an more indepth guide regarding a specific function so someone using the documentation to setup unit tests would not know to look there unless they happened to be in the process of upgrading winter.

As a user I want to see the available helper functions

Current behaviour

• I open the Helpers section in the left hand menu
• The main content area just displays a single paragraph but no helpers

Expected behaviour

• I open the Helpers section in the left hand menu
• The main content area displays all available helpers

We need to update the document generation code to create a 1.0, 1.1 and 1.2 version of the documentation.

We also need an interface to choose for which Winter CMS version we want to browse the documentation.

Winter CMS Build

1.2

PHP Version

8.0

Database engine

No database

Plugins installed

No response

Issue description

php artisan winter:test command throws an error when run with the phpunit.xml file from the docs in a brand new plugin.

Cannot open file "[truncated]/plugins/bdx/toolbox/../../../tests/bootstrap.php".

Steps to replicate

1. Create new Winter CMS project
2. Create new plugin (php artisan create:plugin)
3. Create phpunit.xml file in plugin directory, contents from docs
4. Run php artisan winter:test

Workaround

Replace the bootstrap="" line with the following contents. (Not sure if this is actually correct, but it works).

<?xml version="1.0" encoding="UTF-8"?>
<phpunit backupGlobals="false"
         backupStaticAttributes="false"
         bootstrap="../../../modules/system/tests/bootstrap/app.php"
         colors="true"
    ...

Also include the follow up commands / instructions for setting up databases and configs and running migrations etc.

There's no /public directory, and install doesn't create it, so composer instalation doesn't work "out of the box"

https://wintercms.com/docs/ui/icon

In Winter it's very easy to override specific view files for anything that uses the ViewMaker trait.

\Backend\Widgets\Filter::extend(function ($widget) {
     $widget->addViewPath(__DIR__ . '../widgets/filter/partials');
});

now you can override any existing partial or even provide a new partials for that widget. You can also get fancier by controlling when exactly you call addViewPath() and on which specific instances of whichever class you're trying to override. The above example was placed in a controller's constructor in order to only extend the filter widget for that specific controller, but it could have easily been placed in the index() method to further limit, or various events could have been listened to in order to further limit the overriding of the partials.

^

TODO: Document that in an easy to find and easy to read way. @damsfx @WebVPF any suggestions?

On the main documentation page

ie

https://wintercms.com/docs/v1.2/docs/setup/installation

there is a version dropdown in the top left.
however no options other that 1.2 are available

Check is this correct example with code? It's just the lines are repeated.
https://wintercms.com/docs/database/query#in-memory-caching

Db::table('users')->get(); // Result from database
Db::table('users')->get(); // Result from database

Model::all(); // Result from database
Model::all(); // Result from in-memory cache