OS2borgerPC / os2borgerpc-docs

OS2BorgerPC documentation
https://os2borgerpc.github.io/os2borgerpc-docs/
MIT License
0 stars 0 forks source link

Dokumentation af angivelse af admin-url ved installation af ny BorgerPC #7

Open NeutraChikara opened 2 weeks ago

NeutraChikara commented 2 weeks ago

Funktionaliteten lavet i https://github.com/OS2borgerPC/os2borgerpc-client/issues/5 skal dokumenteres.

NeutraChikara commented 2 weeks ago

Jeg har skrevet følgende dokumentation, og vedhæfter det bare her, da jeg ikke er sikker på hvor det skal ligge, men det tænker jeg @agnetemoos måske har et input til?

For at gøre det så nemt som muligt at installere nye BorgerPC'er, er der lavet en mekanisme, som gør det nemt at angive URL'en til admin siden man ønsker at forbinde til, så man ikke skal taste den ind for hver maskine. Når registreginsscriptet Registrer i OS2borgerPC Admin køres fra skrivebordet på en BorgerPC, forsøger den på 2 måder at tilgå foruddefinerede URL'er til en admin side, i følgende prioritet:

  1. Lokalt monteret drev:

    • Rodmappen på alle monterede drev scannes efter en fil navngivet AdminSiteUrl.txt.
    • Hvis denne fil findes, anvendes URL'en i filen automatisk som URL til admin-siden. Filen skal kun indeholde en URL, intet andet.
    • I praksis vil det give mening at ligge denne fil på samme USB-drev, som man installerer BorgerPC fra.
  2. URL fra fælles OS2 repository:

    • Hvis filen AdminSiteUrl.txt ikke findes på nogen monterede drev, tilgås https://github.com/OS2borgerPC/os2borgerpc-admin-site-urls, der indeholder filen AdminSiteUrls.yaml.
    • AdminSiteUrls.yaml, som alle kan opdatere gennem pull requests, indeholder en samling af URL'er til forskellige admin-sider.
    • Disse URL'er præsenteres som muligheder, der kan vælges imellem. Det er også muligt at ignorere disse valgmuligheder og manuelt indtaste en URL, hvis dette ønskes.
agnetemoos commented 2 weeks ago

Tusind tak, @NeutraChikara

Det er rigtig fint at du overlever dokumentation på denne måde lige nu, hvor vi endnu ikke er færdige med at træffe beslutninger om dokumentationen.

Jeg tænker at det hører naturligt hjemme i anvender-dokumentationen som pt. er bagt ind i Django-sitet. Det ligger her: https://github.com/OS2borgerPC/os2borgerpc-admin-site/tree/master/admin_site/templates/documentation

Det må vi tage en snak om hvad vi vil med det.