Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

11 add a reference document explaining business values and rationales behind the governance criteria #22

43 changes: 43 additions & 0 deletions docs/values_and_rationale_da.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Open Source fra OS²

## Ensartede værdier for forretningen og effektive driftsfordele på tværs af applikationer

##### 🇬🇧 [Read in english](../docs/values_and_rationale_en.md)

## Lave barrierer for gennemsigtighed og sammenhæng i dokumentationsprocessen
_Ved at integrere vores dokumentationsproces direkte med kildekoden skaber vi en gnidningsfri integreret arbejdsgang til vedligeholdelse og opdatering af dokumentationen, hvilket baner en klar vej til at holde den opdateret._

###### Anvendte standarder og teknologier: [Markdown](https://github.github.com/gfm/#what-is-github-flavored-markdown-) | [Github & Git](https://docs.github.com/en/get-started/start-your-journey/about-github-and-git) | [Docs som kode](https://www.writethedocs.org/guide/docs-as-code/)

#### 🎁 Lav barriere for bidrag
Bidrag til dokumentationen foregår i simple tekstdokumenter med enkel syntaks og frit valg mellem et væld af åbne værktøjer tilgængelige på alle platforme. Det sikrer mere nøjagtig dokumentation og letter samarbejdet mellem udviklere og tekniske skribenter.

#### ✅ Konsistens og standardisering
Dokumentationen kan holdes i en ensartet stil og formatering på tværs af alle dokumenter. Dette gør det nemmere for brugerne at navigere og forstå indholdet.

#### 🔀 Gennemsigtighed og samarbejde
Dokumenter er versioneret sammen med kildekoden med den samme værktøjskasse. Dette giver dig mulighed for at se, hvordan dokumentationen har udviklet sig, og spore ændringer. Det forbedrer gennemsigtigheden og samarbejdet og reducerer kontekstskifte, hvilket gør det nemt at bidrage til dokumentationen uden afbrydelser.

### Strømlinet, opdateret dokumentation med åben adgang og indbygget søgning
_Ved brug af moderne dokumentationsteknologi og automatiseringsmetoder som Continous Integration, leveres en åben og søgbar dokumentationsportal automatisk, når dokumentationen opdateres_

###### Anvendte teknologier og metoder: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub-sider](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages) | [Jekyll](https://jekyllrb.com/) | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) | [Kontinuerlig integration](https://www.ibm.com/topics/continuous-integration)

#### 🌐 Åben adgang
Ved at gøre dokumentationen offentlig tilgængelig via en webside, der er indekseret af eksterne søgemaskiner (som Google), fjernes de administrations- og kommunikationsopgaver, der er forbundet med at give adgang til dokumentationen. Alle interessenter kan nemt finde og bruge det via deres foretrukne søgemetoder og søgemaskiner. Dette sparer tid og gør det nemmere for alle at få adgang til dokumentationen.

#### 🔎 Indbygget hurtigsøgning
Via automatisk indeksering og et simpelt, globalt tilgængeligt søgefelt foreslås emner og sektioner vedrørende de indtastede søgeord.
Dette understøtter hurtig og nem adgang til præcis den dokumentation brugerne efterspørger uden behov for manuel vedligeholdelse af indholdsfortegnelser og emneresuméer.

#### :medal_military: Kvalitet og pålidelighed
Automatisk opdatering af dokumentationen hver gang nye versioner af softwaren frigives sikrer, at dokumentationen altid er opdateret. Dette reducerer risikoen for forældede eller unøjagtige oplysninger.

## Genbrug af hyldevarer
_for at sænke vedligeholdelse omkostninger og forhindre låsning til enkelte udviklerhuse teknologier eller hostingleverandører_ svarer overens med digitaliseringstyrelsens og kls arkitekturprincipper


## 4. Godkendelses drevet drift
5. Transparente samarbejdsmetoder
6. Automatiseret ændringslog
7. Hurtig skabelon til udrulning
85 changes: 85 additions & 0 deletions docs/values_and_rationale_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Open Source from OS²

## Uniform business values and effective operational advantages across applications

##### 🇩🇰 [Read in danish](../docs/values_and_rationale_da.md)

## Low Barriers for Transparency and Consistency in the Documentation Process
_By integrating our documentation process directly with the source code, we create a seamless environment for maintaining and updating our documentation, paving a clear path for keeping it up to date._

###### Standards & technologies used: [Markdown](https://github.github.com/gfm/#what-is-github-flavored-markdown-) | [Github & Git](https://docs.github.com/en/get-started/start-your-journey/about-github-and-git) | [Docs as Code](https://www.writethedocs.org/guide/docs-as-code/)

#### 🎁 Low Barrier for contributions
Contributions to the documentation take place in simple text documents with simple syntax and free choice between a multitude of open tools available on all platforms. It ensures more accurate documentation and facilitates collaboration between developers and technical writers.

#### ✅ Consistency and standardization
The documentation can be kept in a uniform style and formatting across all documents. This makes it easier for users to navigate and understand the content.
It reduces confusion and ensures that all documents follow the same standard

#### 🔀 Transparency and cooperation
Documents are versioned alongside the source code, with the same toolbox. This allows you to see how the documentation has evolved and track changes. It improves transparency and collaboration, and reduces context switching making it easy to contribute to the documentation without interruption.

## Streamlined up-to-date documentation with open access and built in search
_Using modern documentation technology and automation metods like Continous Integration, An open and searchable documentation portal is delivered automatically when the documentation is updated_

###### Technologies and methods used: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages) | [Jekyll](https://jekyllrb.com/) | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) | [Continous Integration](https://www.ibm.com/topics/continuous-integration)

#### 🌐 Open access
By making the documentation publicly available via a web page that is indexed by external search engines (like Google), the administration and communication tasks associated with providing access to the documentation are removed. All stakeholders can easily find and use it via their preferred search methods and search engines. This saves time and makes it easier for everyone to access the documentation.

#### 🔎 Built-in quick search
Via automatic indexing and a simple, globally accessible search field, topics and sections relating to the entered keywords are suggested.
This supports quick and easy access to exactly the documentation users demand without the need for manual maintenance of tables of contents and subject summaries.

#### :medal_military: Quality and reliability
Automatic updating of the documentation every time new versions of the software are released ensures that the documentation is always up to date. This reduces the risk of outdated or inaccurate information.


## Maximizing Software Quality & Efficiency with Reusability

###### Principles used: [Upstream first](https://ospo-alliance.org/ggi/activities/upstream_first/)


#### 📤 Shared Maintenance:
When changes are contributed upstream, the maintenance burden for those changes is shared with the community, reducing the load on your own team.


#### 🛡️ Improved Security:
Open source software (OSS) is developed by a large community. It’s rigorously tested and vulnerabilities are patched quickly.


#### 🌟 Quality:
OSS taps into a global pool of talent, leading to better code and quick bug fixes.

#### Safely Leverage Advanced Tech:
OSS allows businesses to leverage advanced tech and have access to the latest innovations.

#### Lower TCO / Cost efficiency
0 licensing fees
As a result of these factors, the Total Cost of Ownership (TCO) of open source solutions is often significantly lower than that of proprietary software.


#### Customizability:
OSS delivers a level of flexibility that proprietary software often cannot match.
When external changes happend, they are not always communicated all the way down to the application development teams. This leaves short time to adapt the software to the new external conditions, impeeding a greater risk of non-compliant, non-functioning, unstable or maybe even insecure software.

#### Freedom:
OSS provides the freedom to use, modify, and redistribute the software. Businesses aren’t locked into a single vendor and can collaborate to improve the software.

#### Transparency:
Open Source Software (OSS) is founded on transparency and collaboration, fostering trust in digital infrastructure. This transparency enables everyone to scrutinize the way the software’s operates, unlike proprietary software where the source code is unavailable. That gives you the freedon to delegate the review and assesesment of the product’s security, efficiency, and quality to independent experts, mitigating the risk of blind trust.

#### Interoperability:
OSS is usually compatible with other software applications, making it easier to integrate into various systems and saving time and money.

#### Upstream First Policy:
An upstream-first policy ensures that any changes your business makes to the open source software are contributed back to the original project. This has several benefits:
- Future Compatibility: By contributing changes upstream, you ensure that your modifications will be compatible with future versions of the software.

- Influence: Contributing to the upstream project can give your business a say in the project’s direction, allowing you to help shape the software in a way that benefits your business.


Safely Leverage Advanced Tech: OSS allows businesses to leverage advanced tech and have access to the latest innovations.