Skip to content

Restructure the documentation #103

@rekjuh

Description

@rekjuh

As discussed 15.4.2025:

The new structure would be:

  1. Introduction
    Inc. the following parts from Application framework:
    2.1 framework,
    2.2. frontend,
    2.4. backend and
    2.4.1 for the section which describes Oskari backend as an application that can be customized for a specific need.

"The backend architecture in oskari-server Maven-modules ..." from 2.4.1 goes to section 5.

  1. Setup
    The Updating instructions will be moved to section 11)

  2. Frontend framework

Inc. 2.3 Frontend bundle implementation convention

  1. Server application
    inc. Oskari-server Maven modules from 2.4.1.
    inc. authentication in general

  2. Functionalities
    inc. section "Other functionalities"
    inc. configuration instructions for each functionality
    inc. authentication/registeration of the end-user

  3. Operating instructions

  4. Developing instructions
    inc. Git branches from Introduction)

  5. Configuration instructions8.

  6. Enabling modules

  7. Updating

  8. Application troubleshooting

  9. Changelog

RPC will have its own section or header. No place for it as of yet. The RPC section should contain the following: https://oskari.org/documentation/api/bundles/latest/RPC

Other changes: The H3 level of headers will be removed from navigation (1.1.1., 2.1.3. etc)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions