ongr-io / docs.ongr.io Goto Github PK

As example we have contributing rules, so we need a single file sync. It might be configurated as a custom sidebar entry from a single repo file.

Customization section is too complicated, is uneccessary and includes only ConnectionsBundle.

The tree should look like this:

• Customizations
• Connections

Also, probably all structure files, like sync.rst, should be moved to ConnectionsBundle itself.

In README you guys still mentioning to use Vagrant as a development environment, but AFAIK you guys switched to use Docker

https://github.com/ongr-io/development-environment

Please update the documentation.

Regards.

We might want to adopt standardized version of sphinx documentation.

See: http://documentation-style-guide-sphinx.readthedocs.org/

Old docs: http://ongr-handbook.readthedocs.io/en/latest/components/ElasticsearchBundle/dsl/highlights/index.html

We need to have an easy to maintain place where we answer questions / tutorials / ... can be collected and maybe answered; also by a growing community.

Examples:

• How to sort products by a boosting?
• How to search (boosted) through multiple fields?
• ...

https://raw.githubusercontent.com/ongr-io/ongr-handbook/master/source/index.rst

See logs: https://readthedocs.org/builds/ongr/2125973/

The fix is to convert that single GIF to PNG.

Usefull info: https://github.com/nfq-extremes/fox-demo/wiki/Big-Picture

Requirements have it's own page, but is it really needed? If yes, points should be enumerated in bullet point list or separated in small sections.

Every bundle docs have to be versioned separately. The version selection should be saved in a cookie.

There is still a question how to perform a search, do we need to look at the version selection or just search through latest versions.

Version selection should be implemented by minor tags or branch.

http://ongr.readthedocs.org/ is not updated for quite a while.

Standards page has incorrect license header. Update it.

http://docs.ongr.io/ returns 500 internal server error

How could we implement this? We need to think of a method.

Besides python separate install should be done for: sudo apt-get install python-setuptools.
Maybe we should consider adding it to manual?

Hi.

It seems like there is a mistake in mapping documentation ("Multiple object" section). We shouldn't use use Doctrine\Common\Collections\ArrayCollection. Probably it was meant ONGR\ElasticsearchBundle\Collection\Collection.

Using of ArrayCollection leads to error in /vendor/ongr/elasticsearch-bundle/Result/Converter.php:

private function isCollection($property, $value)
    {
        if (!$value instanceof Collection) {
            $got = is_object($value) ? get_class($value) : gettype($value);

            throw new \InvalidArgumentException(
                sprintf('Value of "%s" property must be an instance of Collection, got %s.', $property, $got)
            );
        }
    }

http://docs.ongr.io/

502 Bad Gateway