okffi / open-api-definition

Community governed definition of open API
http://okffi.github.io/open-api-definition/
Creative Commons Zero v1.0 Universal
7 stars 7 forks source link

Määritelmän github.io-sivuston resurssien latautumisen korjaaminen #23

Open pe3 opened 8 years ago

pe3 commented 8 years ago

Ainakin mulle tulee listallinen erroreita, kun menen sivustolle okffi.github.io/open-api-definition/ .

screen shot 2015-12-01 at 13 53 23

Resurssien linkit ovat väärin. Esim. modernizr.js löytyy osoitteesta http://okffi.github.io/open-api-definition/js/modernizr.js

pe3 commented 8 years ago

Näin siis kun menee repon etusivulla tarjottuun linkkiin: http://okffi.github.io/open-api-definition/. @apoikola vinkkasi toisen osoitteen, jonka kautta sivusto näyttää ehjältä http://avoinrajapinta.fi/ Ihmettelin tätä myös tuolla hyväksytyssä pull-requestissa.

Eli vaihdetaanko vaan repon linkki toimivaksi? Vai pitäisikö molemmat saada toimimaan. Toimimaton github.io-sivustohan edelleen on internetissä ja linkki siihen mahdollisesti levinnyt. Saako tuon toimimattoman github.io-sivuston poistettua ilman että se haittaa avoinrajapinta.fi-sivustoa?

d2s commented 8 years ago

Hmm, tuota github.io -domainin alla olevaa osoitetta ei voi poistaa, koska se itse sivusto latautuu sieltä. CNAME -tiedostossa on määritetty oikea domain, mutta GitHub ei suoraan implementoi redirectiä oikeaan osoitteeseen. Tiedostojen URL -osoitteet ovat /abc -tyylisiä ihan siitä syystä koska ne toimivat silloin oikein sekä localhost -testiympäristössä että myös virallisessa julkisessa osoitteessa (eli http://avoinrajapinta.fi/ osoitteessa).

Potentiaalisen ongelman korjaaminen olisi mahdollista esim. jollakin JavaScript-pätkälle joka katsoisi että jos URL-osoite on väärän domainin alla, JavaScript tekisi uudelleenohjauksen uuteen sijaintiin.

Mygee commented 8 years ago

Ping @pe3 ja @d2s. Ongelma on nyt korjattu. Määrittelin Jekylliin base URL:n.

d2s commented 8 years ago

@Mygee Äskeinen muutoksesi korjasi osan ongelmista, mutta samalla sivun rakenteesta hajosi OpenGraph -tagit.

screenshot from 2015-12-06 22 11 34 okffi avoinrajapinta opengraph meta tags - duplicate url

Kyseinen kohta generoituu _includes/head.html tiedostosta, jossa on tällä hetkellä useampi URL-määritys peräkkäin.

 <meta property="og:image" content="{{ site.url }}{{ site.baseurl }}/img/{{ page.og-image }}">

Olettaisin että toinen kahdesta määrityksestä on turha. Pelkkä site.url riittää todennäköisesti.

pe3 commented 8 years ago

Hienoa. Arvelinkin, että noin täytyy pystyä tekemään.

pe3 commented 8 years ago

Olitpa hienosti tarkkana @d2s Hyvä, että muistit tarkistaa.

d2s commented 8 years ago

Jostakin syystä https://okffi.github.io/open-api-definition/ osoitteessa oleva sivu ei vieläkään näy oikein, vaikka sekä kuvatiedostojen että CSS-tiedostojen osoitteet ovatkin nyt jo oikein.

screenshot from 2015-12-06 22 21 06 avoinrajapinta

pe3 commented 8 years ago

Jälkimmäisessä näköjään käytössä HTTPS. HTTPS-sivu ei ehkä saa ladattua turvatonta tavaraa.

d2s commented 8 years ago

Kaikki linkit eivät sisällä oikeaa URL-osoitetta, joten ne osoittavat väärään paikkaan (ainakin alihakemistossa olevassa sivukopiossa).

screenshot from 2015-12-06 22 30 27 avoinrajapinta

En ole aivan varma, mutta osa ongelmasta johtuu _includes/post_detail.html -tiedostossa olevasta kohdasta.

<a href="{{ root_url }}{{ post.url }}">{{ post.title }}</a>
d2s commented 8 years ago

Aikaisemmin mainittu URL-ongelma on korjattu jo jokin aika sitten Git commit https://github.com/okffi/open-api-definition/commit/c3e21fb71638626206ce35604d265a0fe42a1a19 muutoksessa. Tuolta osin linkkiongelma on siis korjattu, vaikka alkuperäistä ongelmaa resurssien lataamisen kanssa muutos ei korjaakaan.

screenshot from 2015-12-23 01 38 37 okffi git commit

Mygee commented 8 years ago

Nyt Jekyll 3:n jälkeen ainakin osoite: http://okffi.github.io/open-api-definition/ -> toimii moitteetta. https://okffi.github.io/open-api-definition/ -> ei toimi, mutta en tiedä tarvitaanko tässä SSL:ää?

d2s commented 8 years ago

Jotain JavaScript -pohjaista redirect -viritelmää voisi (teoriassa) harkita. Se tarkistaisi selaimessa olevan URL-osoitteen, ja jos kyseessä olisi 'väärä' sijainti, ohjaisi sivun oikeaan URL-osoitteeseen. En tosin tiedä onko tuollaisen tekeminen erityisen tärkeää kenellekään.

Mygee commented 8 years ago

https://github.com/isaacs/github/issues/289

d2s commented 8 years ago

Ilmeisesti URL-osoitteissa pitäisi olla absolute path jotta eivät uudelleenohjautuisi vahingossa.

Esimerkiksi näin:

- <li><a href="/about">About</a></li>
+ <li><a href="/about/">About</a></li>

Tarkempi esimerkki Ruby-koodista löytyy toisesta Jekyll-projektista: https://github.com/talklittle/talklittle.github.com/commit/9772836155232de001c65c4fd3eff15a6b3888b5

En tosin tiedä auttaako tuo muille kuin perinteisille linkeille.