ubports/docs.ubports.com

Push service documentation

Opened this issue · 6 comments

it appears there is some documentation about our push service over at https://gitlab.com/ubports/development/core/lomiri-push-service/-/tree/main/docs

I think we should incorporate it, but i'm not sure how to approach it yet

wouldn't be better to have it be readable in the docs? i think it'll read easier

Ah, ok. yeah, good point. maybe. to be honest, I haven't looked at the content of what's in the docs about push and what's in lomiri-push-service (lps) repo ... Although, it might be that if the maintainers of lps are describing some intricate technical details in their repository, then one might chose to let them keep doing it rather than trying to copy the info over just to find out that in a year lps has changed but nobody re-aligned the docs ... But, I'm just talking out loud, as I said I haven't actually read either documentation. Another thought might be that if the content should be in the docs, one could reach out to the lps maintainers and ask them where they think the content should be (and where they are most comfortable maintaining it)

Another thought, if lps devs rather have it in their repo, but it's hard to read, then it might be best to improve the language at the source ... I mean it's all us ;)

yeah that is fair granted the docs hasn't changed in years, i believe the maintainer is @Flohack74

Did not even know that docs are existing :D