polar icon indicating copy to clipboard operation
polar copied to clipboard

Add example configuration to documentation

Open jedi-of-the-sea opened this issue 1 year ago • 4 comments

Summary

Example configurations have been added to the documentations of the core and the plugins.

jedi-of-the-sea avatar Aug 07 '24 11:08 jedi-of-the-sea

Sometimes I used the exact configuration of the existing clients, I hope that is not a problem.

During the middle of the time I worked at the ticket I wondered if it would be better to make 'example configuration' a title. I originally decided against it because there where parts where the font would become very small.

I made the code expandable if the configuration was particularly long.

AdressSearch Plugin: searchMethod.queryParameter type gazeteer is deprecated, and there was no example in the clients so I ommited it

jedi-of-the-sea avatar Aug 07 '24 11:08 jedi-of-the-sea

Please resolve the merge conflicts. Once resolved, ping me again :)

🏓 @jedi-of-the-sea

dopenguin avatar Aug 08 '24 06:08 dopenguin

@dopenguin 🏓

jedi-of-the-sea avatar Aug 08 '24 13:08 jedi-of-the-sea

Please add an example for the in #144 added features of scale. You can merge that branch in here if you want. Same can go for the example for #159.

https://github.com/Dataport/polar/pull/158/commits/4023cf259bc336c8799ac47f475f99d034290342

https://github.com/Dataport/polar/pull/158/commits/ca28f988add83e555f9a4104205396b3f2a58457

I did not merge the branches, but I think this should work without conflicts 🤞

@dopenguin 🏓

jedi-of-the-sea avatar Aug 14 '24 13:08 jedi-of-the-sea

@dopenguin 🏓

jedi-of-the-sea avatar Aug 21 '24 10:08 jedi-of-the-sea