Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Versioriippumattoman sisällön lisäämismahdollisuus #37

Open
ilkkarinne opened this issue Jan 21, 2022 · 0 comments
Open

Versioriippumattoman sisällön lisäämismahdollisuus #37

ilkkarinne opened this issue Jan 21, 2022 · 0 comments
Labels
enhancement New feature or request sivuston ominaisuudet koskee ry-tietomallit -sivuston kehittämistä

Comments

@ilkkarinne
Copy link
Contributor

ilkkarinne commented Jan 21, 2022

Nykyversiossa kaikki tietyn tietomallin alla oleva sisältö on kiinnitetty tiettyyn linkitetyn GitHub-repon committiin, eli on riippuvaista tietystä julkaisuversiosta. Tämä onkin hyvä tietyn version speksien osalta, kosta tällöin ei vahingossakaan voi muuttaa speksiä ilman uutta julkaisua, mutta lisäksi tarvitaan myös tietomallia yleisesti kuvaavaa, versioriippumatonta sisältöä, mm. tietomallin yleiskuvaus ja UKK.

Ajatus on toteuttaa tämä niin, että kunkin modulin konfigraatiossa on sekä yleiset navigaatiolinkit (juuritason nav_items), että kunkin version alaiset, versiokohtaiset linkit. Ensin mainituille tuotetaan versionumerottomat linkkipolut navigaatioon ja jälkimmäisille versionumerolliset:

versions:
  - id: "v1.0"
    title: "Asema- ja yleiskaavan tietomallit -projektin lopputulos"
    path: "v1.0"
    default: true
    nav_items:
    - groupId: "looginenmalli"
        title: "Looginen tietomalli"
        nav_items:
          - pageId: "dokumentaatio"
            title: "Dokumentaatio"
...
  - id: "dev"
    title: "Seuraava kehitysversio"
    path: "dev"
    development: true
    dependencies:
      - module: "yhteisetkomponentit"
        version: "dev"
    nav_items:
    - groupId: "looginenmalli"
        title: "Looginen tietomalli"
        nav_items:
          - pageId: "dokumentaatio"
            title: "Dokumentaatio"
...
basepath: "kaavatiedot"
note: "Fyysiset mallit (Kaava-JSON ja Postgre) on siirretty Asema- ja yleiskaavojen tietomallit -kehitysprojektin alle"
nav_items:
  - pageId: "johdanto"
    title: "Johdanto"
    path: ""
    file: "index.md"
    default: true
- pageId: "ukk"
    title: "Usein kysytyt kysymykset"
    path: "ukk.html"
    file: "ukk.md"

Käyttöliittymässä versioriippumattomat navigointilinkit tulisivat vasemman reunan modulin navigointipalkissa modulin otsikon ja versiovalitsimen väliin.

Versioriippumattomat sisältösivut tallennetaan suoraan ry-tietomallit-repoon ko. tietomallin juurihakemiston alle, esim. docs/kaavatiedot/, ja siellä nykyisin oleva uudelleenohjaus oletusversion oletussivulle poistuisi.

Tässä pitää huomioida myös versiovalitsimen toiminnan muutos: Nykyisellään uuden version valinta vaihtaa nykyisen sivun (osoitteesta) vain versionumeron toiseen, eli oletetaan, että kaikissa versioissa on samat sivut. Tämä on käyttäjäystävällistä, kun versionvaihdossa sama sivu tulee näkyviin automattisesti eikä sitä tarvitse uudelleen etsiä. Muutoksen yhteydessä pitää päättää onko mahdollista vielä pyrkiä tähän, kun eri versiossa voi olla eri sivut, vai ohjataanko käyttäjä valitun version oletusivulle.

@ilkkarinne ilkkarinne added enhancement New feature or request sivuston ominaisuudet koskee ry-tietomallit -sivuston kehittämistä labels Jan 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request sivuston ominaisuudet koskee ry-tietomallit -sivuston kehittämistä
Projects
None yet
Development

No branches or pull requests

1 participant