DOC: Forbedringer for dokumentasjon på data.norge.no

[hegeaal]

📖 Dokumentasjon

• Nytt design for dokumentasjonssider. Retningslinjer for infobokser, lenker og lignende. #987
• Legge til en side for "forarbeid", lenker til digdir etc.
  • Kan enten være ny side eller oppdatere

Oppdatering av eksisterende infosider

• Redigere tekst på infosider i henhold til tilbakemeldinger  #999
• Eksempel på hvordan endelig turtle-fil skal se ut (på siden "Hvordan lage beskrivelser") #1000
• Flytte innhold fra Strapi til fdk-frontend #1005 (PRI)

Nye infosider

• Trinn-guide A-Å ved bruk av registreringsløsning (?) (droppes til fordel for generelle infosider)
• [DOC]: Trinn-guide A-Å ved egenlagde beskrivelser i RDF-format #986
• Infoside: Hva er RDF og hvorfor bruker vi det? #997
• Ofte brukte kodelister til datasettbeskrivelser og hvordan bruke dem #1002
• Side om metadata-kvalitet #998
• Informasjon om registreringsløsningene #1001
• Turtle-fil som viser alle obligatoriske (og ev. alle) felter i datasettbeskrivelse
• Skrive kort oppsummering om hvordan Dele data (og vis til nasjonal verktøykasse)

Avhenger av ny dok-side-løsning

Før disse issuene kan tas tak i trenger vi ny løsning for deploy og publisering av dokumentasjonssider, siden vi er avhengig av komponenter fra Designsystemet:

• Legge til "steg"/trinnvis docs
• Tydliggjøre hvilke steg som hører til hvilken fremgangsmåte
• Legge til infoboks om ting som må være på plass/prerequisites (tilganger, tidligere steg)
• Legge til link/kontaktskjema for forbedringsforslag til dokumentasjon

[Terje]: foreslår å skille ut som eget issue sånn at dette hovedissuet ikke avhenger av det:

• POC: Kan man ha live visning av turtle som man genererer i skjema ved siden av skjemaet? #984

[terjesyl]

Trenger vi en egen "Trinn-guide A-Å ved bruk av registreringsløsning"? @KjerstiSteien @KurtStian
Er det noe her vi ofte får spørsmål på? Overlater gjerne den skrivejobben til noen som har mer erfaring med registreringsløsningen, og vet mer om hvilke spørsmål vi får der.

[KurtStian]

Det er noe som burde ha vært forklart/gitt informasjon om. Her er noen eksempler på hva jeg tror vi burde ha vært gitt informasjon om (usortert rekkefølge):

• Hvordan registrere/oppdatere en beskrivelse (f.eks. forklare knappene utkast, godkjenn, publiser og slett, autolagringen, at man ikke trenger å avpublisere for å endre en opplysning, [for begrep - ikke autolagring, om versjoner, kommentarfeltet, endringslogg, endringsforslag inkl. "under revidering", om publisering (hvordan og ikke mulig å avpublisere/slette)] )
• Kanskje si noe om kravsnivåene (obligatorisk, anbefalt og valgfri)
• Hva er prosessen etter at en beskrivelse har fått status/publiseringstilstand "Publisert"
• Hvordan kan man manuelt kan starte høsting (force update)
• Informasjon om Administrasjonspanelet
• Informasjon om muligheten for å importere begrep inn i registreringsløsningen
  • Kan kun gjøres av en med rettighet "Virksomhetadministrator"
  • Hvordan importere. Her finnes det beskrivelse, men den er ikke lett tilgjengelig. Man skulle også ha hatt lenke til veiledningene direkte fra begrepsregistreringsløsningen (gjerne i tilknytning til knappen "Importer)
• Om de tre tilgangene (lese, skrive og virksomhetsadmin) som finnes og hvilke rettigheter disse gir i registreringsløsningen for de forskjelle ressurstypene

[terjesyl]

Takk for info! Legger det til i issuet

[terjesyl]

Men da foreslår jeg at dropper vi steg-for-steg-guiden, og lager mer generelle informasjonstekster om de tingene du lister opp her @KurtStian .