{"id":46589512,"url":"https://github.com/oskariorg/oskari-docs","last_synced_at":"2026-03-07T13:08:46.199Z","repository":{"id":15373889,"uuid":"18105128","full_name":"oskariorg/oskari-docs","owner":"oskariorg","description":"Oskari documentation and Node.js app running oskari.org","archived":false,"fork":false,"pushed_at":"2025-04-01T09:04:50.000Z","size":105205,"stargazers_count":9,"open_issues_count":34,"forks_count":20,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-01T10:22:45.366Z","etag":null,"topics":["documentation","hacktoberfest","oskari"],"latest_commit_sha":null,"homepage":"http://www.oskari.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oskariorg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-03-25T15:24:31.000Z","updated_at":"2025-04-01T09:04:56.000Z","dependencies_parsed_at":"2025-04-01T10:32:08.962Z","dependency_job_id":null,"html_url":"https://github.com/oskariorg/oskari-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/oskariorg/oskari-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oskariorg%2Foskari-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oskariorg%2Foskari-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oskariorg%2Foskari-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oskariorg%2Foskari-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oskariorg","download_url":"https://codeload.github.com/oskariorg/oskari-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oskariorg%2Foskari-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30214748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T12:15:00.571Z","status":"ssl_error","status_checked_at":"2026-03-07T12:15:00.217Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","hacktoberfest","oskari"],"created_at":"2026-03-07T13:08:45.586Z","updated_at":"2026-03-07T13:08:46.181Z","avatar_url":"https://github.com/oskariorg.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Oskari support site\n\n![Oskari](/documents/oskari_rgb_72_v2.png)\n\n[Oskari](http://www.oskari.org/) Map Application Framework aims to provide a framework and a collection of functionality-enhancing bundles and plugins for rapid development of feature-rich GI web applications.\n\nDocumentation available at [http://www.oskari.org].\n\n# Reporting issues\n\nAll Oskari-related issues should be reported here: https://github.com/oskariorg/oskari-docs/issues\n\n# Contributing\n\nPlease read the [contribution guidelines](http://oskari.org/documentation/development/how-to-contribute) before contributing pull requests to the Oskari project.\n\n------------------\n\n## Installation\n\n```\n// clone the repository\ncd oskari-docs\nnpm install\nnode app\n```\n\nAdditionally, if you want the `.less` and `.js` files to be compiled to and linked from `/public`, run `gulp` in the main directory.\n\n## Structure\n\nDocumentation and guides are in `md` directory as `markdown` documents. After creating a new document remember to reference it from either a page in `views/documentation.jade` or `views/guides.jade` (or another appropriate place) or from another document.\n\nWhen added under `md/documentation` or `md/guides` the page is automatically routed to `/documentation/\u003cfile location without the md extension\u003e` or `/guides/\u003cfile location without the md extension\u003e`, respectively.\n\nAll the other content should be placed in the `.jade` templates under `views/`. Also, please see the `routes.js` for details on how the content gets rendered.\n\n### Updating the RPC-client for example page\n\n1. Update the \"oskari-rpc\" dependency version in package.json\n2. Run `npm update oskari-rpc`\n3. Run `npm run build-rpc`\n\nThis updates the public/js/rpc/rpc-client.min.js file\n\n### Generating API documentation for Oskari version\n\n1. Clone oskari-frontend git-repository next to oskari.org repository (at the same folder level)\n2. Checkout to specific tag/version on the Oskari repository you want to create docs for\n2. Run `VERSION=1.45.0 npm run docs`\n\nThis generates files under generated/api/[version] folder.\n\n# Generating database documentation\n\nA mini-site documenting the database structure can be generated with a [custom fork of Schemaspy](https://github.com/oskariorg/schemaspy). Java 8 or newer is required. Command `npm run db` generates documentation into directory `generated/db` by connecting to a database instance and reading its structure. By default a database named `oskaridb` on localhost is used, but any Oskari database instance can be used by changing `schemaspy/conf.properties`. The generated db documentation is mapped to route `/db/`.\n\n## License\n \nThis work is dual-licensed under MIT and [EUPL v1.1](https://joinup.ec.europa.eu/software/page/eupl/licence-eupl) \n(any language version applies, English version is included in https://github.com/oskariorg/oskari-docs/blob/master/documents/LICENSE-EUPL.pdf).\nYou can choose between one of them if you use this work.\n \n`SPDX-License-Identifier: MIT OR EUPL-1.1`\n\nCopyright (c) 2014-present National Land Survey of Finland\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foskariorg%2Foskari-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foskariorg%2Foskari-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foskariorg%2Foskari-docs/lists"}