Aloittelijan yleisimmät virheet Silverstripessä ja niiden välttäminen

Silverstripe CMS:n käytössä ensimmäiset ongelmat liittyvät usein pieniin väärinkäsityksiin. Tallennettu teksti ei ilmesty verkkosivulle, valikosta piilotettu asiakirja on edelleen avattavissa tai ulkoasumuutos katoaa päivityksen yhteydessä. Näissä tilanteissa järjestelmä voi toimia oikein, vaikka lopputulos poikkeaa käyttäjän odotuksista.

Virheitä ehkäisee parhaiten oman sivuston toimintatavan ymmärtäminen. Silverstripeä voidaan mukauttaa laajasti, joten toiselle sivustolle kirjoitettu ohje ei aina vastaa oman hallintapaneelin näkymää.

Tässä oppaassa käsitellään sekä sisällöntuottajan että teknisen ylläpitäjän tavallisia kompastuskiviä. Tarkoituksena on auttaa tunnistamaan ongelman syy ennen kuin pieni epäselvyys johtaa tarpeettomiin muutoksiin.

Tallentaminen sekoitetaan julkaisemiseen

Yksi tavallisimmista tilanteista on se, että sivua muokataan ja tallennetaan, mutta julkisella sivustolla näkyy edelleen aikaisempi sisältö.

Silverstripessä luonnos ja julkaistu versio voivat olla erillisiä. Tallennus säilyttää työn hallinnassa, mutta muutoksen näyttäminen kävijöille edellyttää julkaisemista.

Toimi järjestelmällisesti:

1. Muokkaa oikeaa sivua.
2. Tallenna muutokset.
3. Tarkista luonnoksen esikatselu.
4. Julkaise valmis sisältö.
5. Avaa julkinen sivu uudelleen.

Esikatselussa kannattaa tarkistaa, onko valittuna luonnos vai julkaistu versio. Väärän tilan katsominen voi saada toimivan tallennuksen näyttämään epäonnistuneelta. Silverstripen esikatseluohje.

Jos julkaisupainiketta ei ole, selvitä käyttöoikeudet ja sivuston hyväksyntäkäytäntö. Puuttuva toiminto ei välttämättä tarkoita ohjelmistovirhettä.

Valikosta piilottamista pidetään suojauksena

Sivun poistaminen navigaatiosta vähentää sen näkyvyyttä, mutta ei välttämättä estä avaamista suoralla osoitteella. Sama väärinkäsitys koskee tiedostoja: asiakirja ei muutu yksityiseksi sillä, että sen linkki poistetaan tekstistä.

Silverstripen tiedostoilla voi olla omat katseluoikeutensa. Julkaistu ja kaikille sallittu tiedosto voi olla saatavilla, vaikka sitä ei olisi sijoitettu millekään sivulle. Silverstripen tiedostojen käyttöoikeudet.

Jos aineisto kuuluu vain jäsenille, määritä siihen todellinen käyttöoikeusrajaus. Tarkista erikseen sekä sisältösivu että ladattava asiakirja.

Kokeile lopputulosta uloskirjautuneessa selainikkunassa. Ylläpitäjän tunnuksilla tehty tarkistus ei osoita, mitä tavallinen kävijä pystyy avaamaan.

Kaikille annetaan täydet ylläpitäjäoikeudet

Laajojen oikeuksien jakaminen voi tuntua helpolta ratkaisulta, kun käyttäjä ei pääse tarvitsemaansa toimintoon. Samalla hän voi kuitenkin saada mahdollisuuden muuttaa koko sivuston asetuksia tai muiden käyttäjien oikeuksia.

Silverstripen ryhmillä ja rooleilla voidaan muodostaa tehtäviin sopivia oikeuskokonaisuuksia. Käyttäjä voi kuulua useaan ryhmään, joten oikeuksien selvittämisessä pitää huomioida kaikki jäsenyydet. Silverstripen rooli- ja ryhmäohje.

Määrittele ensin, mitä henkilön kuuluu tehdä:

• Kirjoittaa luonnoksia.
• Julkaista hyväksyttyä sisältöä.
• Käsitellä kuvia ja asiakirjoja.
• Ylläpitää tiettyä sivuston osiota.
• Hallita käyttäjiä.

Testaa oikeudet tavallisella käyttäjätunnuksella. Säilytä henkilökohtaiset tunnukset, jotta vastuut ja käyttöoikeuksien poistaminen pysyvät selkeinä.

Toisen version ohjetta seurataan sellaisenaan

Hakukoneesta löytyvä opas voi käsitellä vanhempaa Silverstripe-versiota. Komennot, luokkien nimet ja hakemistorakenteet ovat voineet muuttua, vaikka ohjeen tavoite kuulostaisi oikealta.

Tarkista aina dokumentaation versionvalitsin ja vertaa sitä sivustosi versioon. Selvitä lisäksi, koskeeko ohje järjestelmän perustoimintoa vai erikseen asennettavaa moduulia.

Pidä yllä lyhyttä projektikuvausta, josta löytyvät:

• Silverstripen versiosarja.
• Käytettävä PHP-versio.
• Keskeiset moduulit.
• Kehitys- ja julkaisukomennot.
• Ylläpidosta vastaava henkilö.

Jos ohjeen ensimmäinen komento epäonnistuu, älä jatka seuraaviin vaiheisiin arvaamalla. Lue virheilmoitus ja selvitä, onko kyse väärästä versiosta, puuttuvasta riippuvuudesta vai ympäristöasetuksesta.

Palvelimen yhteensopivuutta ei tarkisteta

Pelkkä PHP-tuki ei takaa Silverstripen toimivuutta. Asennus tarvitsee käytettävän version mukaiset laajennukset, tietokantayhteyden ja verkkopalvelimen asetukset.

Ongelma voi näkyä vasta tietyssä toiminnossa. Etusivu avautuu, mutta kuvien käsittely epäonnistuu, koska tarvittava laajennus puuttuu.

Tarkista vaatimukset ennen asentamista ja päivittämistä. Huomioi myös, että komentorivin PHP ja verkkopalvelimen PHP voivat olla eri versioita.

Silverstripen palvelinvaatimuksissa eritellään muun muassa PHP-laajennukset, kuvankäsittely ja tietokantatuki. Silverstripen ympäristövaatimukset.

Älä ohita Composerin yhteensopivuusilmoituksia vain saadaksesi asennuksen etenemään. Korjaa varsinainen puute tai valitse ympäristöön sopiva ratkaisu.

Koko projekti sijoitetaan julkiseen hakemistoon

Silverstripe-projektin kaikki tiedostot eivät kuulu selaimella avattaviksi. Verkkopalvelimen dokumenttijuuren pitäisi osoittaa projektin public-alihakemistoon.

Jos palvelin osoittaa väärään kansioon, sivuston toiminta ja tiedostojen suojaus voivat poiketa tarkoitetusta. Myös osoitteiden uudelleenkirjoituksen täytyy toimia.

Tarkista erityisesti:

• Verkkotunnuksen dokumenttijuuri.
• Palvelimen uudelleenkirjoitusasetukset.
• Tiedostojen omistajuus.
• Tarvittavien kansioiden kirjoitusoikeudet.

Älä ratkaise kirjoitusvirhettä antamalla kaikille täydet oikeudet koko projektiin. Tarvittavat oikeudet määräytyvät palvelimen käyttäjien ja tallennuskohteiden mukaan. Silverstripen verkkopalvelinasetukset.

Jos käytät webhotellia, varmista palveluntarjoajalta oikea määritystapa ennen hakemistojen siirtämistä.

Kehitystila jää julkiselle sivustolle

Kehitysympäristössä yksityiskohtaiset virhetiedot auttavat selvittämään ongelmia. Julkisella sivustolla sama tieto voi paljastaa tarpeettomia teknisiä yksityiskohtia.

Silverstripen ympäristötila määritellään tavallisesti ympäristöasetuksissa. Tuotantosivustolla käytetään live-tilaa:

SS_ENVIRONMENT_TYPE="live"

Tämä ei yksin tee sivustosta turvallista, mutta se on tärkeä osa oikeaa ympäristömääritystä. Silverstripen ympäristötilat.

Pidä testiympäristön tietokantayhteys ja palvelutunnukset erillään tuotannosta. Muuten harjoituskomento voi kohdistua oikeaan asiakasdataan.

Tarkista myös sähköpostit ja integraatiot. Testikopion ei pitäisi lähettää kokeiluviestejä todellisille asiakkaille tai käynnistää tuotannon toimintoja vahingossa.

Ulkoasua korjataan väärästä tiedostosta

Silverstripen sivupohjia ja tyylejä voi tulla useasta lähteestä. Aloittelija saattaa muokata tiedostoa, jota sivusto ei käytä, tai tehdä korjauksen asennettuun ohjelmistopakettiin.

Teemojen asetukset määrittelevät resurssien ja sivupohjien hakujärjestystä. Siksi saman tiedostonimen löytyminen projektista ei vielä todista, että juuri kyseinen tiedosto muodostaa näkyvän sivun. Silverstripen teemojen toiminta.

Selvitä ensin:

• Mikä teema on käytössä?
• Mistä sivupohja tulee?
• Mitä CSS-tiedostoa selain lataa?
• Tarvitaanko erillinen rakennusvaihe?

Tee omat muutokset projektin sovittuun paikkaan. Suoraan riippuvuuksiin tehdyt korjaukset voivat kadota päivityksessä.

Vältä uusien CSS-ohitusten lisäämistä ennen kuin tiedät, miksi alkuperäinen sääntö ei vaikuta.

Päivitys tehdään suoraan tuotannossa

Komento composer update voi muuttaa useita riippuvuuksia. Jos se suoritetaan ensimmäiseksi julkisella sivustolla, yhteensopivuusongelma voi näkyä heti käyttäjille.

Silverstripen ohje suosittelee ratkaisemaan ja testaamaan päivitykset kehitysympäristössä. Testattu composer.lock viedään tuotantoon, jossa riippuvuudet asennetaan lukitustiedoston perusteella. Silverstripen Composer-ohje.

Toimiva järjestys on:

1. Ota palautettavat varmuuskopiot.
2. Päivitä testiympäristö.
3. Suorita tarvittavat tietokanta- ja rakennusvaiheet.
4. Tarkista keskeiset toiminnot.
5. Julkaise sama testattu kokonaisuus.
6. Tarkista tuotannon toiminta.

Pelkkä etusivun avaaminen ei riitä. Kokeile myös kirjautumista, julkaisemista, tiedostojen lataamista ja sivuston tärkeimpiä lomakkeita.

Varmuuskopiosta unohtuu osa sivustoa

Tietokannan vienti ei sisällä kaikkia kuvia. Pelkkä tiedostopaketti puolestaan ei sisällä tietokantaan tallennettuja sivutekstejä ja käyttäjätietoja.

Palautusta varten tarvitaan yhteensopiva kokonaisuus:

• Tietokanta.
• Ladatut tiedostot.
• Oma koodi ja teemat.
• Riippuvuuksien lukitustiedosto.
• Tarvittavat ympäristöasetukset.

Selvitä myös mahdollisen ulkoisen tiedostotallennuksen ja suojattujen aineistojen sijainti. Älä oleta kaiken löytyvän yhdestä kansiosta.

Kokeile palauttamista erilliseen ympäristöön. Varmuuskopion onnistumisilmoitus kertoo vain osan tilanteesta; toimiva palautus osoittaa, että kopioita pystytään käyttämään.

Pidä vähintään yksi suojattu kopio erillään varsinaisesta palvelimesta ja dokumentoi palautuksen vaiheet.

Poistamista pidetään aina peruttavana

Silverstripessä arkistointi ja poistaminen eivät ole sama toiminto. Arkistoitava sisältö voidaan palauttaa luonnokseksi, mutta kaikkien sisältötyyppien arkistointi ei välttämättä ole käytössä.

Erityisesti tiedostojen arkistointi on käyttäjäohjeen mukaan oletuksena pois käytöstä. Delete-painiketta ei siis pidä tulkita automaattisesti palautettavaksi roskakoriksi. Silverstripen arkistointiohje.

Ennen poistamista selvitä, missä aineistoa käytetään ja tarvitaanko sitä vielä. Kokonaisen kansion kohdalla tarkista myös sen sisältö.

Jos tarkoitus on vain ottaa sivu pois näkyvistä, selvitä julkaisun peruuttamisen mahdollisuus. Valitse toimenpide tavoitteen perusteella, älä pelkästään sen mukaan, mikä painike löytyy ensimmäisenä.

Muutoksen vaikutusta ei tarkisteta kävijänä

Hallintapaneelissa kaikki voi näyttää oikealta, vaikka julkisella sivulla kuva puuttuu tai linkki johtaa vanhaan osoitteeseen. Ylläpitäjän oikeudet voivat myös peittää katselurajoituksiin liittyvän ongelman.

Tee jokaiselle merkittävälle muutokselle lyhyt lopputarkistus:

• Avaa sivu uloskirjautuneena.
• Kokeile linkit ja ladattavat tiedostot.
• Tarkista puhelinnäkymä.
• Testaa muutettu toiminto.
• Varmista, ettei vanha sisältö rikkoutunut.

Kun ongelma ilmenee, kirjaa tarkka osoite, käyttäjärooli ja toistovaiheet. Selkeä havainto auttaa ylläpitäjää ratkaisemaan asian nopeammin kuin yleinen ilmoitus siitä, ettei sivusto toimi.