Ryhti-hankkeen piiriin kuuluvien rakennetun ympäristön tietomallien yhteinen dokumentaatiosivusto. Sivustoa hallinnoi Suomen ympäristökeskus, ja tietomallien muutoshallintaprosessista vastaa ympäristöministeriö.
Dokumentaatio on koottu pääosin tämän repon wikiin, ks. muun muassa sivut
RY-tietomallit sivusto on rakennettu siten, että sen sisältö koostuu pääosin toisista git-repoista noudettavista lähdekooditiedostoista. Linkitys ry-tietomallit-reposta toisiin git-repoihin on toteutettu git submodule-mekanismilla. Näin voidaan esittää samalla sivustolla useamman kuin yhden tietomallin version kuvaus linkittämällä ko. tietomallirepon eri release-tagien mukaisiin committeihin, ks. lisää wiki-sivu Tietomallien kehittäminen ja ylläpito.
Sivulle voidaan linkittää mitä tahansa julkisia git-repoja, ja GitHub Pages -osaa noutaa ko. linkkien asetetun commitin mukaiset sisällöt automaattisesti sivuston buildauksen yhteydessä. Huom: Mikäli moduli ei ole julkaistu GitHub:issa, sen sivumetatieto-laatikon muutostietojen esittäminen ei onnistu, sillä sen tiedot haetaan JavaScriptillä käyttäen GitHub REST APIa.
Kulloinkin linkatut git submodulet ja niiden tilan saa tulostettua (linux-tyyppisessä komentoriviympäristössä) seuraavalla loitsulla:
$ git submodule foreach --quiet 'printf "\n$sm_path: linked to " && git remote get-url origin && printf "at " && git describe --tags --first-parent --dirty --always'Seuraavassa listassa on lueteltu rakennetun ympäristön yhteentoimivuustyössä tunnistettuja tietomalleja, jotka on tarkoitus tuoda sivustolle omina moduleinaan tulevaisuudessa:
- Alueiden käytön suunnittelu
- Yleisten alueiden suunnitelmat
- Kaavatietomallin soveltamisprofiili maakuntakaavoille
- Merialuesuunnitelma
- Kulttuuriympäristö
- Rakennettu kulttuuriympäristö
- Rakennusperinnön ja arkeologisen kulttuuriperinnön suojelu
Sivuston kehittämisessä on huomattavasti hyötyä paikallisesta kehitysympäristöstä, jossa tietoihin tehtävät muutokset saa näkyviin esikatseluna ilman tietojen viemistä GitHub Pages - mekanismilla julkaistulle Rakennetun ympäristön tietomallit-sivustolle.
Mikäli valmistelet uutta versiota kehitettävästä tietomallista tai uutta sivustolle tuotavaa tietomallia, noudata sisältörepojen kehittämis- ja ylläpito-ohjetta tämän repon wikissä.
GitHub Pages -sivugenerointia voi simuloida varsin uskottavasti paikallisella työasemalla ajaen Docker GitHub Pages -Docker-konttia:
- Asenna Docker Engine, ja komentorivi-git, mikäli ei jo asennettu.
- Tee juurihakemisto koneelle kloonatuille git-repoille ja siirry sinne
- Tee oma fork git-reposta sykefi/ry-tietomallit
- Kloonaa forkkisi paikalliselle työasemalle:
$ git clone https://github.com/<oma-gh-tunnus>/ry-tietomallit.git
- Päivitä kaikki alimodulit ajantasalle:
$ git submodule init; $ git submodule update;
- Siirry hakemistoon
ry-tietomallit/docs - Käynnistä docker-github-pages -kontti porttiin 4000:
$ docker run -it --rm -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages
- Sivusto tulee buildauksen jälkeen näkyviin osoitteeseen http://localhost:4000/ Mikäli tulee virheilmoitus "docker: Cannot connect to the Docker daemon...", varmista, että asentamasi Docker Engine on käynnissä taustalla.
- Muokkaa sivuston tietoja tarpeellisilta osin, varmista, että kaikki näyttää hyvältä osoitteesta http://localhost:4000/
- On hyvä käytäntö olla tekemättä muutos-committeja suoraan linkitettyjen submodulien sisältöihin, ja tyypillisesti tietomallien kehittäjillä ei ole siihen oikeuksiakaan. Voit toki kokeilla muutoksia paikallisesti, kopioida ne sitten muutoksiksi linkitettyihin repoihin, commitoida ja pushata, palauttaa muutokset ry-tietomallit -repon linkitetyissä hakemistoissa
git restore-komennolla, ja tehdä pull ry-tietomallit -repon paikallisen klooniin ko. modulin hakemistossa.