Developer documentation updates #12849
Conversation
Build Artifacts
|
MisRob
force-pushed
the
docs-new-howtos
branch
from
6051875 to
96af3fe
Compare
MisRob
force-pushed
the
docs-new-howtos
branch
from
96af3fe to
b3e7706
Compare
ozer550
left a comment
ozer550
left a comment
There was a problem hiding this comment.
Some pointers that I observed while testing this personally.
rtibbles
left a comment
rtibbles
left a comment
There was a problem hiding this comment.
Everything looks fine here, just need to refine the guidance for getting the IP address - should be instructing people to look out for this logging block from the Kolibri python devserver:
INFO 2024-11-19 15:14:21,967 Kolibri running on: http://A.B.C.D:8000/
INFO 2024-11-19 15:14:21,967 Kolibri running on: http://127.0.0.1:8000/
|
Thank you, I will update. Any thoughts on this @rtibbles @nucleogenesis?
|
|
It does not simulate Android in any way shape or form, no - it only emulates our 'app mode' which allows for certain elevated privileges for the logged in user, which we leverage in our apps. I believe I also update this guidance in this draft PR: #12879 |
|
Thanks @rtibbles |
|
Also just resolved the feedback |
nucleogenesis
left a comment
nucleogenesis
left a comment
There was a problem hiding this comment.
This looks great to me - seems like all feedback from other reviewers has been addressed. This all reads very well and I'm thankful for the reminder of this option <3
| ------------------------- | ||
|
|
||
| Once you have the server running, proceed to import some channels and resources. To quickly import all available and supported Kolibri resource types, use the token ``nakav-mafak`` for the `Kolibri QA channel <https://kolibri-beta.learningequality.org/en/learn/#/topics/95a52b386f2c485cb97dd60901674a98>`__ (~350MB). | ||
| Once you have the server running, proceed to import some channels and resources. To quickly import all available and supported Kolibri resource types, `import with the token <https://kolibri.readthedocs.io/en/latest/manage/resources.html?highlight=import#import-with-token>`__ ``nakav-mafak`` for the `Kolibri QA channel <https://kolibri-beta.learningequality.org/en/learn/#/topics/95a52b386f2c485cb97dd60901674a98>`__ (~350MB). |
There was a problem hiding this comment.
This was pre-existing, but kolibri-beta doesn't exist any more! I think just updating this to kolibri-demo should be fine, although BCK is currently having some difficulties, so I can't be sure!
There was a problem hiding this comment.
We can update this in follow up, so as not to hold this up further!
4 participants
Summary
Couple of updates of developer documentation How To Guides in response to volunteer work + small cleanup.
Reviewer guidance
Comments
@nucleogenesis @rtibbles I am not entirely sure how pre-existing https://kolibri-dev.readthedocs.io/en/develop/manual_testing/app_plugin/index.html fits into the mobile device landscape. Does this command simulate Android? If so, should we cross-reference with the new mobile device guide, or place these two pages close to each other, or even have on a single page? And how should I best explain in what cases app plugin is preferred?