Skip to content

Ryhti-hankkeen piiriin kuuluvien rakennetun ympäristön tietomallien dokumentaatiosivusto

Notifications You must be signed in to change notification settings

sykefi/ry-tietomallit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Rakennetun ympäristön tietomallit

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

Linkitetyt repot

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.

Nimi versio hakemistopolku linkitetty git-repo tagi / haara / commit huom
RY-yläontologia dev docs/ry-ylaontologia/dev github.com/sykefi/ry-ylaontologia develop
RY-yhteiset komponentit dev docs/ry-yhteiset/dev github.com/sykefi/ry-yhteiset develop
RY-yhteiset komponentit 1.0.0 docs/ry-yhteiset/dev github.com/sykefi/ry-yhteiset
RYTJ-soveltamisprofiili dev docs/rytj-soveltamisprofiili/dev github.com/sykefi/rytj-soveltamisprofiili develop
Kaavatiedot 1.0.2 docs/kaavatiedot/v1.0 github.com/sykefi/kaavatietomalli
Asemakaavan soveltamisprofiili 1.0 docs/kaavatiedot/soveltamisprofiili/asemakaava/v1.0 github.com/sykefi/sp-asemakaava
Yleiskaavan soveltamisprofiili 1.0 docs/kaavatiedot/soveltamisprofiili/yleiskaava/v1.0 github.com/sykefi/sp-yleiskaava
Kaavatiedot 1.1.0 docs/kaavatiedot/v1.1 github.com/sykefi/kaavatietomalli
Kaavatiedot dev docs/kaavatiedot/dev github.com/sykefi/kaavatietomalli develop
Tonttijakosuunnitelma 1.1 docs/tonttijakosuunnitelma/v1.1 github.com/sykefi/Tonttijakosuunnitelman-tietomalli
Tonttijakosuunnitelma 1.0.1 docs/tonttijakosuunnitelma/v1.0 github.com/sykefi/Tonttijakosuunnitelman-tietomalli
Tonttijakosuunnitelma dev docs/tonttijakosuunnitelma/dev github.com/sykefi/Tonttijakosuunnitelman-tietomalli develop
Rakennuskohteet dev docs/rakennuskohteet/dev github.com/sykefi/rakennuskohteet develop
Rakennuskohteet 1.0.1 docs/rakennuskohteet/dev github.com/sykefi/rakennuskohteet
Rakentamisen lupapäätökset dev docs/rakentamisenluvat/dev github.com/sykefi/rakentamisenluvat develop
Rakentamisen lupapäätökset 1.0.0 docs/rakentamisenluvat/dev github.com/sykefi/rakentamisenluvat
Yhteiset Sisältömakrot docs/_includes/common github.com/sykefi/rytm-jekyll-includes main
Rakennusjärjestys dev docs/rakennusjarjestys/dev github.com/Kuntaliitto/rakennusjarjestys develop
Rakennusjärjestys 1.0.1 docs/rakennusjarjestys/v1.0 github.com/Kuntaliitto/rakennusjarjestys
Maankäyttörajoitukset 1.0 docs/maankayttorajoitukset/v1.0 github.com/sykefi/maankayttorajoitusten-tietomalli ei tagiä v1.0.0!
Maankäyttörajoitukset dev docs/maankayttorajoitukset/dev github.com/sykefi/maankayttorajoitusten-tietomalli develop
Kaupunkiseutusuunnitelma dev docs/kaupunkiseutusuunnitelma/dev github.com/sykefi/kaupunkiseutusuunnitelma develop
Kaupunkiseutusuunnitelma 1.0.1 docs/kaupunkiseutusuunnitelma/v1.0 github.com/sykefi/kaupunkiseutusuunnitelma

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'

Suunnitellut tietomallit

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

Paikallinen kehitysympäristö

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:

  1. Asenna Docker Engine, ja komentorivi-git, mikäli ei jo asennettu.
  2. Tee juurihakemisto koneelle kloonatuille git-repoille ja siirry sinne
  3. Tee oma fork git-reposta sykefi/ry-tietomallit
  4. Kloonaa forkkisi paikalliselle työasemalle:
    $ git clone https://github.com/<oma-gh-tunnus>/ry-tietomallit.git
  5. Päivitä kaikki alimodulit ajantasalle:
    $ git submodule init;
    $ git submodule update;
  6. Siirry hakemistoon ry-tietomallit/docs
  7. Käynnistä docker-github-pages -kontti porttiin 4000:
    $ docker run -it --rm -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages
  8. 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.
  9. Muokkaa sivuston tietoja tarpeellisilta osin, varmista, että kaikki näyttää hyvältä osoitteesta http://localhost:4000/
  10. 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.

About

Ryhti-hankkeen piiriin kuuluvien rakennetun ympäristön tietomallien dokumentaatiosivusto

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published