Giter Site home page Giter Site logo

Comments (5)

tobiasberge avatar tobiasberge commented on June 7, 2024

Hi @svlauer,

thank you for your contribution.

In general I would agree to document the new component_filter_panel_items because it is very unlikely to change compared to specific filters. However there may be cases where the developer want's to have a new filter before or after another filter. Maybe we could document the component_filter_panel_items as the primary solution and then add another sentence like "If you need your filter next to a specific filter, you can also use the filter's individual blocks e.g. component_filter_panel_item_shipping_free {code_exmample}".

For the version: I think you could prepare an info box in your pull request which stays open until it is clear in which version the block will be released. Approximately this could be v6.4.8.0:

{% hint style="info" %}
The block `component_filter_panel_items` is available from Shopware Version 6.4.8.0
{% endhint %}

from docs.

svlauer avatar svlauer commented on June 7, 2024

This sounds sensible. Given the (suboptimal) hardcoding of the order of the filters provided by core, it is good to have the additional hint, as you suggest.

Thank you for the tip with the info box! I plan to roll a pull request soonish.

from docs.

svlauer avatar svlauer commented on June 7, 2024

Quick question (not sure if this is the best place to ask - feel free to tell me to go somewhere else):

Is there a way for me to "build" the documentation locally, to test my changes before doing a pull request? I can of course test the basic markdown easily, but what about {% code %} or {% hint %} directives? (I am not familiar with gitbook, and looking at their website is not terribly helpful ...)

from docs.

elkmod avatar elkmod commented on June 7, 2024

Hi @svlauer. Thank you a lot for the pull request! As of now, unfortunately, we're unaware of a proper way to preview the changes. I propose that we will review the published article, once the PR has been merged and, if necessary, make some quick fixes.

from docs.

svlauer avatar svlauer commented on June 7, 2024

Thanks for the explanation! Ok ... the template tags are simple enough, so probably everything is going to be fine. But it felt wrong to do a PR without proper testing ... (and I thought I must have missed something).

from docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.