search

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 tekstin automaattinen päivittäminen Jekyll:iin #5

Closed apoikola closed 8 years ago

apoikola commented 9 years ago

Pitäisi olla niin, että originaalimateriaali tulisi suoraan reposta julkiselle puolelle. Nyt tein vain gh-pagesin manuaalisesti, koska en osannut.

apoikola commented 9 years ago

Täällä on ohjeistuksia, miten voisi toimia ehkä.. https://stackoverflow.com/questions/15214762/how-can-i-sync-documentation-with-github-pages

pe3 commented 8 years ago

gh-pages-haara on niin roskainen, mm _drafts, että ei houkuta ratkaisemaan tarvetta. gh-pages-branchiin voisi tehdä scripts-kansion, johon sh-skriptin (jolloin se olis mahdollisimman universaalisti ajettavissa), joka tekis about @apoikola:n vinkkaaman, mutta skriptiin pitää/voi koodata mihin paikkaan gh-pagesissa määritelmä laitetaan ja miten se uudelleennimetään version mukaan. Ton _posts-kansion vois nimetä ja konffata toisin, että se olis selkee paikka määritelmän eri versioille.

pe3 commented 8 years ago

Ihmettelin tuolla hyväksytyn pull-requestin lopussa miltä sivusto ainakin mulle näyttää.

pe3 commented 8 years ago

@Mygee kenellä pallo sivuston korjailusta on?

d2s commented 8 years ago

@pe3 GitHub Pages branch ei ole roskainen. _drafts -hakemisto on tuolla sen takia, jotta siitä voi nähdä teeman tukemat syntaksi-esimerkit. Jätin kyseiset tarkoituksella tuonne talteen (erilliseen hakemistoon) jotta ne olisivat vielä tallessa. Samat löytyvät tosin myös alkuperäisen teeman GitHub-projektista joten se toimii myös vaihtoehtoisena sijaintina niiden löytämiseen (jos haluat siivota kyseisen _drafts alihakemiston pois tieltä).

Pallo sivuston korjaamisesta on sillä joka jaksaa tehdä #23 -issuen vastauksessa mainitun JavaScript-pätkän (URL-osoitteen sijainnin testaamiseen). Itselläni ei juuri nyt ole aikaa.

d2s commented 8 years ago

En näe mitään järkevää syytä sille miksi _posts -kansiota kannattaisi nimetä uudestaan. Kyseinen nimeämistapa on Jekyll -sivustogeneraattorin nimeämis-konventio, jonka muuttaminen rikkoisi rakenteen ymmärrettävyyden monelle potentiaaliselle contributorille.

Mygee commented 8 years ago

@pe3 Moi, olen tämän viikon Itävallassa duunissa. @d2s on tehnyt pohjan Jekyllillä, jota sitten hieman muokkasin tähän. Vapaaehtoispohjaltahan tätä tehdään. Tosiaan aika helposti Jekyll menee rikki, joten muokkausten kanssa kannattaa olla varovainen. Kunhan nyt saadaan edes jonkinlainen Open API -työryhmä kasaan, niin se on jo paljon. Saa toki tehdä ja osallistua. Otson ja Jogin kanssa sovittiin, että määritelmän sisältöä päivitetä "iteratiivisesti" vaan hyvin maltillisesti, eli max. kerran vuodessa. Katselen tätä enemmän taas viikonloppuna. Nyt täytyy lähteä nauttimaan Wienistä (ja huomenna aamulla konffasta) :)

pe3 commented 8 years ago

Sori @d2s ei ollut tarkoitus loukata. Mm. nää vuoristokuvat sai mut ajattelemaan, että joku on asiaa enempää miettimättä jättäny kaikki boilerplatet repoon.

pe3 commented 8 years ago

@Mygee @d2s mäkin voin vähän jotain Jekyll-hommaa tehä. Tein joskus tämmösen testin, missä käytin GitHubin sisäänrakennettua Jekyll:iä YAML-JSON renderinä ja "staattisena backendinä" JavaScriptille.

d2s commented 8 years ago

@pe3 No worries. :+1:

Jos ehdit, pull requestit ylimääräisten kuvatiedostojen karsimiseen ovat toki tervetulleita.

Mygee commented 8 years ago

Aletaan järjestämään määritelmän ympärille 3-4 tapaamista vuodessa noin 3 kuukauden välein, missä asioista keskustellaan ja niitä kehitetään.