api-integration-examples icon indicating copy to clipboard operation
api-integration-examples copied to clipboard

Published 20 hours ago • verified publisher icon bitcoinaverage

Add Documentation from #3185

Open gratuxri opened this issue 3 years ago • 4 comments

For tests I have used vyos with pppoe-server: https://docs.vyos.io/en/latest/configuration/service/pppoe-server.html

gratuxri avatar Nov 24 '21 12:11 gratuxri

https://github.com/opnsense/core/issues/3185

gratuxri avatar Nov 24 '21 13:11 gratuxri

I don't think we should add only a script to the docs, different options(https://github.com/opnsense/core/issues/3185#issuecomment-589240675) are probably still on the table, but if we're going for a documentation solution there should be at least some background about what the intended fix would offer and it should fit documentation style (code examples wrapped in a code block, preferably in a separate page since it's only for a selected audience).

AdSchellevis avatar Nov 24 '21 13:11 AdSchellevis

Sorry, it looks better now. Should I open parallel new Pull Request for core? And here explain more about this fix and create extra page?

gratuxri avatar Nov 24 '21 15:11 gratuxri

@gratuxri I was looking for a bit more context, but since you're using my previous script, I've decided to stack it for release with an option in our HA settings (https://github.com/opnsense/core/commit/2cfd70b7ebbcfc9058542b58466176ecda217209). If you can spare some time to write a bit of documentation about the new option, that would be appreciated.

AdSchellevis avatar Nov 24 '21 20:11 AdSchellevis