Skip to content

Commit

Permalink
Merge branch 'master' into feature/app-lib-v8
Browse files Browse the repository at this point in the history
  • Loading branch information
tjololo committed Dec 18, 2023
2 parents 89a5b3e + bcbd1a7 commit 0cdae55
Show file tree
Hide file tree
Showing 791 changed files with 42,203 additions and 6,287 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/hugo-verifications.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
name: Build and Check links
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
submodules: true

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/hugo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
- name: Install Dart Sass Embedded
run: sudo snap install dart-sass-embedded
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
submodules: recursive
- name: Setup Pages
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ public
.DS_Store
.idea
.hugo_build.lock
*.swp
README.md config.toml content i18n layouts public renovate.json resources static themes
*~*.pptx
70 changes: 70 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Contributing to docs.altinn.studio

The site is generated from [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
using the [Hugo](https://gohugo.io/overview/introduction/) static site generator.
We use YAML as front matter.

## Initial setup

1. Download and install [Git](https://git-scm.com/downloads) and clone the [altinn-studio-docs repository](https://github.com/Altinn/altinn-studio-docs) to a local folder:
```bash
git clone https://github.com/Altinn/altinn-studio-docs
```
2. We recommend downloading and using [visual studio code](https://code.visualstudio.com) with
- [this markdown extension](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) for editing markdown and
- [the github extension](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) for helping with pull requests
4. [Download the latest Hugo](https://github.com/gohugoio/hugo/releases) (extended) for your platform, and place the executable in the altinn-studio-docs folder.

## Build / Edit / Test locally

1. Open the altinn-studio-docs repo-folder in visual studio code
2. Run `hugo server --navigateToChanged`. Now baksia is running locally at http://loalhost:1313/
3. Edit and save files in the `content`-folder to automatically get a new local build of the site refreshed in your browser, so you can test your changes locally.

## Push your changes to GitHub
We recommend that you create a pull request when you want to share your changes with the rest of the world.

1. [Create a branch](https://code.visualstudio.com/docs/sourcecontrol/overview#_branches-and-tags) for your changes
2. [Create a pull request](https://youtu.be/LdSwWxVzUpo)

## Deploy
Whenever changes from your pull request are merged into the main-branch, an automatic deploy is updating https://docs.altinn.studio/

PS: If you don't have direct write access to the repo, you need to [create a fork](https://help.github.com/articles/fork-a-repo/)
and submit a [pull request](https://help.github.com/articles/about-pull-requests/) from your fork.

## Internal Code Review Guidelines

General Principles:
1. Avoid terms that might be interpreted as personal attacks (e.g., "idiotic" or "useless"). Assume that everyone is making their best effort.
2. Be moderate in your language. Avoid strong exaggerations like "always," "never," etc.
3. We're all on the same team. The intention is not to criticize but to produce better code.
4. Smaller, frequent pull requests are easier to manage than larger ones. Aim to limit the scope of code to approximately 200 lines for each review.

Guidelines for Reviewers:
1. Focus on the Code, Not the Person: The goal is to elevate the quality of the code, not to showcase your expertise. Be constructive in your feedback.
2. Adhere to Established Standards: Stick to coding conventions and practices that are accepted within the team. Deviations must be justified.
3. Understand the Purpose: Make sure to understand the rationale behind the code you're reviewing. Go through any associated documentation or task definitions.
If something is unclear, ask the author to clarify and/or add comments to the code.
4. Be direct and polite: Avoid wrapping your opinions in questions, like "Have you considered isolating this logic into a separate method?". Instead, be
direct and point out your difference in opinion: "I think this logic would be easier to follow if isolated into a separate method".
5. Clarify Importance: Distinguish between critical issues and lesser suggestions. Make it clear what needs to change before the code can be merged, and
respect the author's right to make the final decision about the rest.

Guidelines for Authors:
1. Self-Check: Review your own code to catch simple errors before requesting a review.
2. Details in Pull Requests: Include an explanatory text that provides reviewers with necessary context.
3. Respond to Reviews: Provide feedback on all comments. A simple "Done" or "Agreed" is often sufficient.
4. Be Receptive: Be open to critique and suggestions. Argue your case if needed but be willing to consider alternatives.

Procedural Rules:
1. Speed is a Virtue: The review should be quick to avoid potential conflicts during merging.
2. More Eyes, Better Outcome: Aim to have at least two reviewers for substantial code changes.


## Links

- [Markdown cheat-sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
- [Hugo configuration](https://gohugo.io/overview/configuration/)
- [Hugo front matter](https://gohugo.io/content/front-matter/)

16 changes: 16 additions & 0 deletions _index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Altinn 3 Broker
linktitle: Broker
description: Altinn 3 Broker offers managed file transfers between providers and consumers.
tags: [architecture, solution]
toc: false
weight: 1
---

{{<notice warning>}} <!-- info -->
This is work in progress
{{</notice>}}

{{<children />}}


15 changes: 15 additions & 0 deletions _index.nb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Formidlingstjeneste
linktitle: Formidling
description: Produktet kan brukes til å sende dokumenter eller store datamengder mellom offentlige virksomheter eller mellom offentlige og private virksomheter.
tags: [architecture, solution]
toc: false
weight: 1
---
*Siden er under utvikling*

For å utvikle løsningen trenger du både å tilrettelegge egne systemer for sending av data, og utvikle selve tjenesten i Altinns tjenesteutviklingsløsning.
Tidlig i prosessen vil vi råde deg til å tenke på hvordan du skal sende ut dokumentene eller dataene til brukerne.

Du kan velge mellom å sende fra maskin til maskin eller fra maskin til portal, for eksempel ved at brukerne mottar dokumentene i innboksen på altinn.no.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/autocomplete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/hidden.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/optionsId.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/pageBreak.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/readOnly.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/required.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/secure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/component-settings/teksttype.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ preservetaxonomynames = true
enableEmoji = true
enableGitInfo = false
disableKinds = ["RSS"] # page home section taxonomy taxonomyTerm RSS sitemap robotsTXT 404
ignoreErrors = ["error-remote-getjson"]

[languages]
[languages.en]
Expand Down
10 changes: 10 additions & 0 deletions content/altinn-studio/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Altinn Studio
description: Altinn Studio - Your tool for developing digital services for citizens and businesses
aliases:
- /altinn-studio/
- /technology/altinnstudio/solutions/altinn-studio/
weight: 1
---

{{<children />}}
54 changes: 0 additions & 54 deletions content/altinn-studio/_index.md

This file was deleted.

10 changes: 10 additions & 0 deletions content/altinn-studio/_index.nb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Altinn Studio
description: Altinn Studio - Ditt verktøy for utvikling av digitale tjenester til innbyggere og næringsliv
aliases:
- /nb/altinn-studio/
- /nb/teknologi/altinnstudio/solutions/altinn-studio/
weight: 1
---

{{<children />}}
79 changes: 79 additions & 0 deletions content/altinn-studio/about/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: About Altinn Studio
description: High-level description of Altinn Studio
aliases:
- /altinn-studio/
- /technology/altinnstudio/solutions/altinn-studio/
weight: 1
---

Altinn Studio is a tool for efficiently realizing digital services. We offer:
- a web-based tool for creating and testing services (apps) - Altinn Studio Designer
- a template for services with standard functionality and the ability to add custom functionality
- a dedicated environment for each service owner to run the services (testing and production)
- a set of common support functions to assist services, e.g., PDF receipt generation, notifications, etc.

## What can I create with Altinn Studio?

### Form services
Traditional forms where the user fills in and submits data on behalf of themselves or others, possibly their business.

### Inspection services
Services where a form is not submitted, but only a request for insight into existing data.

### Guide
Services that guide the user through a process to provide an answer or the right starting point for the way forward.
This type of service also supports users who are not logged in.

### Coordinated services *
Services that typically consist of multiple forms, subprocesses, multiple users, and integrations with other agencies.

{{% notice info %}}
\* Although it is possible to create this type of service today, we are working to make it easier to implement this type
of service by moving more functionality into the web tool.
{{% /notice %}}

## Altinn Studio is the "connector"
A form is rarely just data fields to be submitted; more is needed to create a good service – e.g., connection
to ID-porten, submission to the case processing system via eFormidling, or connection to national registers.

Altinn Studio has pre-developed integrations with several of Digdir's shared services and national registers, and will
continue to develop and add more.

![Altinn Studio is the "connector"](./studio-i-midten.png "Altinn Studio is the connector")

## Low-code and traditional code
Altinn Studio is a hybrid between low-code and traditional coding. This means you can start with low-code in Altinn Studio
Designer and switch to dedicated development tools like Visual Studio Code if you have advanced needs that require coding.

Our goal is to do as much as possible with low-code but retain the option for traditional coding and the flexibility
it provides. This allows non-technical resources to design and publish services without the need to involve developers.
At the same time, a developer can be brought in to create more advanced functionality that requires coding.

![The tool supports both low-code and traditional coding](./nocode_vs_coding.png "The tool supports both low-code and traditional coding")

## Principles that Altinn Studio is built on
Here are some of the principles underlying our development of Altinn Studio.
- **Free and open-source code** because we genuinely believe that openness and the opportunity for others to contribute is the way to go for developing services in the public sector.
- **Based on open standards** because closed code ties you to a supplier and often entails additional costs.
- **Cloud-based infrastructure** where loose connections are sought without binding to a specific cloud provider.
- **Built on modern and popular frameworks/products** because it makes it easier for both us and our customers to acquire technical resources and because it's something one wants to work with/learn.
- **Embedded security** where each layer in the architecture authorizes use regardless of where the calls come from.
- **Isolation** – Service owners get their own environments for testing and production.

### Open source and collaboration
Altinn Studio is not perfect, but it takes you a long way in creating good digital services - and we continuously add new functionality.

Instead of creating something on your own or buying something – why not contribute to the open-source project where there may be gaps
and thus give something back to the community?
The Altinn Studio teams handle quality assurance and ongoing code management.

Creating an environment around the development of services is important to us, and we now have a good number of contributors from
many public agencies contributing to advancing the product with us.
Contributions range from fixing typos that take seconds to fix to major components that have taken months.

An important part of creating an environment is the developer contact we have via Altinn Slack. Each service owner has their own
channel where questions can be asked.
We also see that service owners help each other and share experiences across organizations.
Backlog, user stories, plans, and roadmaps – everything is openly available on GitHub, providing both insight
and comments.
83 changes: 83 additions & 0 deletions content/altinn-studio/about/_index.nb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Om Altinn Studio
description: Overordnet beskrivelse av Altinn Studio
aliases:
- /nb/altinn-studio/
- /nb/teknologi/altinnstudio/solutions/altinn-studio/
weight: 1
---

Altinn Studio er et verktøy for å effektivt realisere digitale tjenester. Vi tilbyr:
- et web basert verktøy for å lage og teste tjenester (apper) - Altinn Studio Designer
- en mal for tjenester med standard funksjonalitet og mulighet for å legge til egen funksjonalitet
- ett dedikert miljø for hver tjenesteeier for kjøring av tjenestene (test og produksjon)
- ett sett med felles støttefunksjoner for å understøtte tjenestene, f.eks. generering av PDF kvittering, varsling, osv.


## Hva kan jeg lage med Altinn Studio?

### Skjematjenester
Tradisjonelle skjemaer hvor brukeren fyller inn og sender inn data på vegne av seg selv eller andre, ev. sin bedrift.

### Innsynstjenester
Tjenester hvor man ikke sender inn et skjema, men kun ber om innsyn i eksisterende data.

### Veileder
Tjenester som veileder brukeren gjennom en prosess for å kunne gi et svar eller rett utgangspunkt for veien videre.
Denne typen tjeneste støtter også brukere som ikke har logget inn.

### Sammenhengende tjenester *
Tjenester som typisk består av flere skjema, delprosesser, flere brukere, og integrasjoner med andre etater.

{{% notice info %}}
\* Selv om det er mulig å lage denne tjenestetypen i dag, jobber vi med å gjøre det enklere å implementere denne
typen tjeneste ved å flytte mer funksjonalitet inn i web verktøyet.
{{% /notice %}}

## Altinn Studio er "bindemiddelet"
Et skjema er sjelden bare datafelter som skal sendes inn, det trengs mer for å lage en god tjeneste – f.eks. kobling
mot ID-porten, innsending til saksbehandlingssystem via eFormidling eller kobling mot nasjonale registre.

Altinn Studio har ferdig utviklet integrasjoner mot flere av Digdir sine fellestjenester og nasjonale registre, og vil
fortsette å utvikle disse og legge til flere.

![Altinn Studio er "bindemiddelet"](./studio-i-midten.png "Altinn Studio er bindemiddelet")

## Lavkode og tradisjonell kode
Altinn Studio er en hybrid mellom lavkode og tradisjonell koding. Det betyr at du kan starte med lavkode i Altinn Studio
Designer, og bytte over til dedikerte utviklingsverktøy som Visual Studio Code om du har avanserte behov som trenger
koding.

Vårt mål er å kunne gjøre mest mulig med lavkode, men beholde mulighet for tradisjonell koding og den fleksibiliteten
det gir. Dette gjør at ikke-tekniske ressurser kan designe og publisere tjenester uten at man må hente inn utviklere.
Samtidig kan man hente inn en utvikler for å lage f.eks. mer avansert funksjonalitet som krever koding.

![Verktøyet støtter både lavkode og tradisjonell koding](./nocode_vs_coding.png "Verktøyet støtter både lavkode og tradisjonell koding")


## Prinsipper som Altinn Studio bygger på
Her lister vi noen av prinsippene som ligger til grunn for vår utvikling av Altinn Studio.
- **Fri og åpen kildekode** fordi vi genuint tror at åpenhet og mulighet for andre til å bidra er veien å gå for utvikling av tjenester i offentlig sektor.
- **Basert på åpne standarder** fordi lukket kode binder deg til leverandør og medfører ofte ekstra kostnader.
- **Skybasert infrastruktur** hvor man tilstreber løse koblinger uten binding mot en spesifikk skyleverandør.
- **Bygges på moderne og populære rammeverk/produkter** fordi det gjør det lettere både for oss og våre kunder å skaffe tekniske ressurser og fordi det er noe man ønsker å jobbe med/lære seg.
- **Innebygd sikkerhet** hvor hvert lag i arkitekturen autoriserer bruken uavhengig av hvor kallene kommer fra.
- **Isolasjon** – Tjenesteeiere får sine egne miljøer, for test og produksjon.

### Åpen kildekode og samarbeid
Altinn Studio er ikke perfekt, men det tar deg et langt stykke på vei for å lage gode digitale tjenester - og vi legger
kontinuerlig til ny funksjonalitet.

I stedet for å lage noe eget eller kjøpe noe – hvorfor ikke bidra til åpen kildekode prosjektet der det ev. er mangler
og på den måten gi noe tilbake til samfunnet?
Altinn Studio teamene håndterer kvalitetssikring og videre forvaltning av koden.

Det å skape et miljø rundt utviklingen av tjenester er viktig for oss, og vi har nå en et godt antall bidragsytere fra
mange offentlige etater som bidrar til å løfte produktet videre sammen med oss.
Bidrag er alt fra retting av skrivefeil som tar sekunder å fikse til store komponenter som har tatt måneder.

En viktig del av det å skape et miljø er den utviklerkontakten vi har via Altinn Slack. Hver tjenesteeier har sin egen
kanal hvor man kan stille spørsmål.
Vi ser også at tjenesteeiere hjelper hverandre og deler erfaring på tvers.
Backlog, brukerhistorier, planer og veikart – alt ligger åpen tilgjengelig på GitHub og gir mulighet for både innsikt
og kommentarer.
Binary file added content/altinn-studio/about/nocode_vs_coding.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/altinn-studio/about/studio-i-midten.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions content/altinn-studio/architecture/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Application construction components Altinn Studio
linktitle: Architecture
description: The application construction components for Altinn Studio includes all components uses to create the Altinn Studio Applications.
weight: 99999
hidden: true
---

The following diagram shows the application construction construction for the Altinn Studio solution with its applications.
Expand Down
8 changes: 8 additions & 0 deletions content/altinn-studio/designer/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Toolkits in Altinn Studio
linktitle: Toolkits
description: Information about Altinn Studios web tools for building digital services
weight: 10
---

{{<children />}}
Loading

0 comments on commit 0cdae55

Please sign in to comment.