Skip to content

Commit

Permalink
Fixes to make docs work with latest Hugo (#542)
Browse files Browse the repository at this point in the history
  • Loading branch information
altinnadmin authored Jul 4, 2024
1 parent abe68e5 commit c722a96
Show file tree
Hide file tree
Showing 77 changed files with 125 additions and 109 deletions.
9 changes: 6 additions & 3 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"recommendations": [
"bungcip.better-toml",
"msjsdiag.debugger-for-chrome",
"yzhang.markdown-all-in-one"
"github.vscode-pull-request-github",
"bierner.markdown-checkbox",
"bierner.markdown-footnotes",
"jonah.markdown-attrs",
"hediet.vscode-drawio",
"stkb.rewrap"
]
}
29 changes: 22 additions & 7 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,30 @@
"[markdown]": {
"editor.wordWrap": "off",
"editor.renderWhitespace": "trailing",
"files.trimTrailingWhitespace": false
"editor.rulers": [ 120 ],
"files.trimTrailingWhitespace": false
},
"breadcrumbs.enabled": true,
"githubRepositories.autoFetch.enabled": true,
"git.autofetch": true,
"git.branchProtection": [
"master",
"main"
],
"git.branchProtectionPrompt": "alwaysCommitToNewBranch",
"git.pullBeforeCheckout": true,
"editor.fontLigatures": true,
"editor.glyphMargin": false,
"explorer.compactFolders": false,
"markdown.preview.breaks": false,
"markdown.preview.markEditorSelection": false,
"workbench.editor.customLabels.enabled": true,
"workbench.editor.customLabels.patterns": {
"content/**/*index.*md": "${dirname}/${filename}.${extname}"

},
"search.exclude": {
"**/node_modules": true,
"static/lunr-index.json": true
},
"cSpell.language": "nb",
"cSpell.words": [
"lenketjenester",
"noen"
]
}
}
2 changes: 1 addition & 1 deletion .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"tasks": [
{
"label": "Hugo",
"command": "${workspaceRoot}/hugo.exe serve --navigateToChanged",
"command": "${workspaceRoot}/hugo serve --navigateToChanged",
"type": "shell",
"isBackground": true,
"presentation": {
Expand Down
19 changes: 9 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,33 @@
# Contributing to Altinn docs

The Altinn docs 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.
The Altinn docs 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 [docs repository](https://github.com/altinn/docs) to a local folder:
1. Install [Git](https://git-scm.com/downloads) and clone the [docs repository](https://github.com/altinn/docs) to a local folder:
```bash
git clone https://github.com/altinn/docs
```
2. We recommend downloading and using [visual studio code](https://code.visualstudio.com) with [this extension](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) for editing markdown.
3. [Download Hugo](https://github.com/gohugoio/hugo/releases/download/v0.92.0/hugo_0.92.0_Windows-64bit.zip) for your platform, and place the executable in the docs-folder.
2. Install [Visual Studio Code](https://code.visualstudio.com) for editing markdown
3. [Install Hugo](https://gohugo.io/installation/) for your operating system

## Build / Edit / Test

1. Open the docs repo-folder in visual studio code (or another editor)
2. Run `hugo server --navigateToChanged` or click "Altinn docs" (Ctrl-Shift-D) in vs code. This generates the site and opens Chrome at http://loalhost:1313/docs/.
2. Run `hugo server --navigateToChanged` open your browser at http://localhost:1313/docs/
3. Edit and save a file in the `content`-folder to get a new local build of the site refreshed in your browser.

## Deploy
Whenever changes are pushed to the docs-repository, an automatic deploy is updating https://altinn.github.io/docs/

If you don't have write access to the docs-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/).
If you don't have write access to the docs-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/).

## 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/)

2 changes: 1 addition & 1 deletion content/api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ Vi har ikke krav til hvordan teksten skal vises, men den skal være godt synlig
- Det er kun mulig å legge meldinger sendt til organisasjoner i søppelbøtten via REST tjenesten. Pr i dag finnes ikke denne muligheten via Webservice


{{% children description="true" depth="1" %}}
{{<children description="true" depth="1" />}}
2 changes: 1 addition & 1 deletion content/api/datasystem/faq_datasystem/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ toc: true
---


{{% children description="true" depth="1" %}}
{{<children description="true" depth="1" />}}
2 changes: 1 addition & 1 deletion content/api/info/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ description: Størrelsesbegrensninger, tips og triks
weight: 1000
---

{{% children description="true" %}}
{{<children description="true" />}}


2 changes: 1 addition & 1 deletion content/api/rest/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ Hvis HTTP-header `Access-Control-Allow-Origin` returneres med ønsket domene, s
[PowerShell]: https://en.wikipedia.org/wiki/PowerShell
[curl]: https://en.wikipedia.org/wiki/CURL

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/api/rest/autorisasjon/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ aliases:
---


{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/api/rest/formidling/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ eller med [virksomhetssertifikat](../kom-i-gang/virksomhet/#autentisering-med-vi

Finn også mer informasjon om formidlingstjeneste under [Guider](/docs/guides/).

{{% children description="true" %}}
{{<children description="true" />}}
6 changes: 3 additions & 3 deletions content/api/rest/kom-i-gang/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ For å få tilgang til brukerens meldingsboks må du autentisere deg. Altinn API

Dersom du trenger tilgang til Altinns REST-api for tjenesteeiere må du bruke virksomhetsautentisering med Maskinporten, virksomhetssertifikat eller en virksomhetsbruker.

{{% children description="true" style="" movetoend="false" %}}


## Du er klar!

Når du har fullført registrering og autentisering er du klar til å integrere systemet ditt med Altinn. Se menyen til venstre for mer informasjon om ulike API-er, og ta en kikk på [utviklingsguidene](../../../utviklingsguider).

Her er en [Postman collection](https://github.com/Altinn/postman-examples) som inneholder eksempler på REST-operasjonene som ligger under https://altinn.no/api/help og https://altinn.no/api/serviceowner/help.


{{<children description="true" style="" movetoend="false" />}}
2 changes: 1 addition & 1 deletion content/api/rest/kom-i-gang/tutorial-postman/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ keywords: [virksomhetsbruker, autentisering, API, REST, Maskinporten, virksomhet
tags: [REST, Autorisasjon, Maskinporten, Autentisering, Postman]
---

{{% children description="true" sort="Weight" %}}
{{<children description="true" sort="Weight" />}}
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Koden i testklienten er skrevet for å være forklarende og lett å lese, men de
For en mer robust API-klient mot Maskinporten laget for .Net Core 5+ kan man bruke [.NET client for Maskinporten APIs](https://github.com/Altinn/altinn-apiclient-maskinporten) som vi også har på Github.
{{% /panel %}}

{{% children description="true" sort="Weight" %}}
{{<children description="true" sort="Weight" />}}
2 changes: 1 addition & 1 deletion content/api/rest/meldinger/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ aliases:
---


{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/api/soap/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Les mer om dette på samarbeidsportalen under [Modernisering av Altinn](https://

Denne delen av SOAP-APIet kan benyttes når eksterne systemer skal integreres mot Altinn. Dersom din etat/kommune er tjenesteeier i Altinn har du tilgang til en ekstra del av SOAP-APIet, denne finner du under [Api for tjenesteeiere > SOAP](/docs/api/tjenesteeiere/soap/).

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/api/tjenesteeiere/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ Metode for oversending| ShipmentDefinition|N/A|Angir forsendelsesoppsett, dvs. u
N/A|ReporteeElementID|N/A|Angir den unike identifikatoren for en spesifikk tjeneste (innsendings-, meldings-, innsyns-, eller samhandlingstjeneste)|Angir den unike identifikatoren for en spesifikk tjeneste (innsendings-, meldings-, innsyns-, eller samhandlingstjeneste)
N/A|CaseID|N/A|Angir den unike identifikatoren for en spesifikk samhandlingstjeneste, benyttes blant annet til å knytte andre tjenester opp mot samhandlingstjenesten.

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/api/tjenesteeiere/rest/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ APIet for tjenesteeiere har en egen teknisk dokumentasjonsside med testklient: <



{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/api/tjenesteeiere/soap/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ Les mer om dette på samarbeidsportalen under [Modernisering av Altinn](https://

Som tjenesteeier må du bruke SOAP når du skal hente skjemadata fra Altinn og for å sende forhåndsutfylte skjema, meldinger, formidle filer til bruker eller organisasjon via Altinn.

{{% children description="true" depth="1" %}}
{{<children description="true" depth="1" />}}
2 changes: 1 addition & 1 deletion content/api/tjenesteeiere/soap/grensesnitt/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: SOAP operasjoner for tjenesteeiere med beskrivelse.
weight: 100
---

{{% children description="true" depth="1" %}}
{{<children description="true" depth="1" />}}
2 changes: 1 addition & 1 deletion content/kom-i-gang-med-utvikling/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Når du har fått tilgangene du trenger, kan du følge [brukerveiledningene unde
for å sette opp og produksjonssette din tjeneste. Du velger om du vil ta i bruk produktene som de er eller integrere dem i ditt eget grensesnitt ved hjelp av API.


{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: Vi jobber stadig med forbedringer i Altinn. Her kan du se hva vi ha
weight: 900
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/prodsetting/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: Produksjonssettinger
description:
weight: 750
---
{{% children description="true" %}}
{{<children description="true" />}}


## Planlagte releaser i 2024
Expand Down
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/prosjekter/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ Altinn er en viktig fellesløsning for digital dialog mellom næringsliv, privat
Digdir skal etablere en ny plattform med tilsvarende funksjonalitet som på Altinn II slik at tjenester som benytter Altinn i dag kan reetableres på ny plattform innen juni 2025. Ny og modernisert arkitektur sørger for at offentlig virksomheter kan samhandle digitalt, og at de har tilgang til nødvendig fellesfunksjonalitet på en mer fleksibel plattform enn tidligere.

Les mer om modernisering av Altinn [her.](https://samarbeid.digdir.no/eformidling/modernisering-av-altinn/1799)
{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/prosjekter/tjenester30/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Tjenester 3.0 inngår som en del av en større modernisering av hele Altinn. Les

Dokumentasjon av Altinn Studio finner du [her](/docs/altinn-studio).

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2015/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Endringer innført i 2015.
weight: 300
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2016/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ weight: 200
---


{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2017/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Endringer innført i 2017.
weight: 100
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2018/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Endringer innført i 2018.
weight: 90
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2019/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Endringer innført i 2019.
weight: 80
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2020/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Endringer innført i 2020.
weight: 70
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2021/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Endringer innført i 2021.
weight: 60
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2022/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Endringer innført i 2022.
weight: 50
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2023/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Endringer innført i 2023.
weight: 40
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/2024/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Endringer innført i 2024.
weight: 30
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/releases/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Endringer i Altinn 2 plattformen gjøres stort sett for å understøtte arbeidet

Modernisering av Altinn innebærer at dagens Altinn dekomponeres, moderniseres og flyttes til Altinn 3 plattformen.
Løsningen som bygges dokumenteres på [https://docs.altinn.studio/](https://docs.altinn.studio/)
{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/roadmap/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ Roadmap for videreutvikling av alle fellesløsninger i Digitaliseringsdirektorat

Informasjon om fremtidig videreutvikling av Altinn finner du på samarbeidsportalen under [Modernisering av Altinn](https://samarbeid.digdir.no/eformidling/modernisering-av-altinn/1799)

{{% children description="false" %}}
{{<children description="false" />}}
2 changes: 1 addition & 1 deletion content/ny-funksjonalitet/roadmap/autorisasjon/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ weight: 900
Informasjon om fremtidig utvikling etter 2022 finner du under [fremdritsplaner for modernisering av Altinn Autorisasjon](https://docs.altinn.studio/authorization/migration/)


{{% children description="false" %}}
{{<children description="false" />}}
2 changes: 1 addition & 1 deletion content/referanse/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ tags: []

**Referanse-seksjonen er under arbeid.**

{{% children description="true" depth="2" %}}
{{<children description="true" depth="2" />}}
2 changes: 1 addition & 1 deletion content/referanse/api-oversikt/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ keywords: [API, REST]
tags: [REST]
---

{{% children description="true" sort="Weight" %}}
{{<children description="true" sort="Weight" />}}
2 changes: 1 addition & 1 deletion content/referanse/openapi-swagger/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ keywords: []
tags: []
---

{{% children description="true" depth="1" %}}
{{<children description="true" depth="1" />}}
2 changes: 1 addition & 1 deletion content/referanse/openapi-swagger/metadata-api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ keywords: []
tags: []
---

{{% children description="true" %}}
{{<children description="true" />}}
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ keywords: []
tags: []
---

{{% children description="true" %}}
{{<children description="true" />}}
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ _build:
render: always
---

{{% children description="true" depth="1" %}}
{{<children description="true" depth="1" />}}
2 changes: 1 addition & 1 deletion content/referanse/openapi-swagger/virksomhet-api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ keywords: []
tags: []
---

{{% children description="true" %}}
{{<children description="true" />}}
2 changes: 1 addition & 1 deletion content/seres/Brukerveiledninger/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Brukerveiledninger til komponentene i SERES.
weight: 100
---

{{% children description="true" depth="2" %}}
{{<children description="true" depth="2" />}}
Loading

0 comments on commit c722a96

Please sign in to comment.