Skip to content

Commit 55ee321

Browse files
committed
docs: Vedlikehold dokumentasjon
1 parent 43aba2d commit 55ee321

File tree

4 files changed

+39
-20
lines changed

4 files changed

+39
-20
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sf-platform
22

3-
Monorepo for NAVs Salesforce Platform core. Maintained by Team Platforce.
3+
Monorepo for NAVs Salesforce Platform core. Vedlikeholdt av Team Platforce.
44

55
[Platforce Documentation](https://navikt.github.io/platforce-doc/)
66

@@ -10,19 +10,32 @@ For å se avhengigheter mellom pakkene se [sfdx-project.json](sfdx-project.json)
1010

1111
- [platform-datamodel](src/platform-data-model/feature-flag-custom-metadata) - datamodell
1212

13-
### Frameworks
13+
### [Frameworks](src/frameworks)
1414

1515
- [feature-toggle](src/frameworks/feature-toggle/README.md) rammeverk for feaure toggling i salesforce
1616

17-
### Platform Utility
17+
### [Platform Utility](src/platform-utility)
1818

1919
- [custom-metadata-dao](src/platform-utility/custom-metadata-dao) - Abstraksjon av custom metadata
20+
- [custom-pemission-helper](src/platform-utility/custom-permission-helper) - Hjelpe funksjoner for custom settings
21+
22+
```mermaid
23+
---
24+
title: Pakkeavhengigheter
25+
---
26+
graph TD
27+
custom-pemission-helper
28+
feature-toggle --> platform-datamodel;
29+
feature-toggle --> custom-metadata-dao;
30+
```
2031

2132
## Komme i gang
2233

23-
Hvordan bygge, teste og kjøre koden viss aktuelt.
34+
For å sette opp utviklingsmiljøet se [Platforce Docs - Developer environment](https://navikt.github.io/platforce-doc/how-to-guides/dev-environment/)
35+
36+
For detaljer rundt utvikling eller bruk av en spesifikk pakke, se pakke beskrivelsen for nærmere beskrivelser.
2437

25-
For detaljer ang. utvikling eller bruk av en pakke, se pakke beskrivelsen.
38+
For å spinne opp en scratch org så kan man ta utgangspunkt i scratch org definition filen som ligger her: `config/project-scratch-def.json`
2639

2740
---
2841

src/frameworks/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Home to framework packages.
1+
# Frameworks
2+
3+
Gruppering av rammeverk
4+
5+
## Pakker
6+
7+
- [feature-toggle](src/frameworks/feature-toggle/README.md) rammeverk for feaure toggling i salesforce

src/frameworks/feature-toggle/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Her kan man velge å bruke enten `customPermission` eller en kombinasjon av `Fea
2626

2727
Ved bruk av bare `customPermission` oppretter man en custom permission og legger den til et Permission Set som tildeles den eller de som trenger tilgangen.
2828

29-
Ved bruk av en kompinasjon så opprettes det et custom permission som tildeles via Permission Set slik som over. I tillegg opprettes det et Feature_Flag**mdt record hvor customPermission api navnet legges til i `Required_Custom_Permission**c`. `Is_Enabled\_\_c` flagget benyttes som vanlig til å toggle featuren av og på.
29+
Ved bruk av en kombinasjon så opprettes det et custom permission som tildeles via Permission Set slik som over. I tillegg opprettes det et `Feature_Flag__mdt` record hvor customPermission api navnet legges til i `Required_Custom_Permission__c`. `Is_Enabled__c` flagget benyttes som vanlig til å toggle featuren av og på.
3030

3131
**Eksempel på direkte bruk:**
3232

@@ -82,3 +82,12 @@ public with sharing MyClass extends FeatureToggleBase {
8282

8383
- [platform-datamodel](src/platform-data-model/feature-flag-custom-metadata) - datamodell
8484
- [custom-metadata-dao](src/platform-utility/custom-metadata-dao) - Abstraksjon av custom metadata
85+
86+
```mermaid
87+
---
88+
title: Pakkeavhengigheter
89+
---
90+
graph TD
91+
feature-toggle --> platform-datamodel;
92+
feature-toggle --> custom-metadata-dao;
93+
```

src/platform-utility/README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
11
# platform-utility
22

3-
Package containing the core platform utilities.
3+
Gruppering av utility pakker
44

5-
The package can only contain utilities that are used by the sf-platform, and can be used by any other re.
5+
## Pakker
66

7-
## Maintainer
8-
9-
Maintained by Team Platforce.
10-
11-
### Henvendelser
12-
13-
Spørsmål knyttet til koden eller prosjektet kan stilles som issues her på GitHub.
14-
15-
### For NAV-ansatte
16-
17-
Interne henvendelser kan sendes via Slack i kanalen #platforce.
7+
- [custom-metadata-dao](src/platform-utility/custom-metadata-dao) - Abstraksjon av custom metadata
8+
- [custom-pemission-helper](src/platform-utility/custom-permission-helper) - Hjelpe funksjoner for custom settings

0 commit comments

Comments
 (0)