From bc0a7a651331b27aca328c140b45257559c32779 Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:40:07 +0100 Subject: [PATCH 01/11] Multilingual templates for values and rationale doc added --- docs/values_and_rationale_da.md | 16 ++++++++++++++++ docs/values_and_rationale_en.md | 3 +++ 2 files changed, 19 insertions(+) create mode 100644 docs/values_and_rationale_da.md create mode 100644 docs/values_and_rationale_en.md diff --git a/docs/values_and_rationale_da.md b/docs/values_and_rationale_da.md new file mode 100644 index 0000000..8851c05 --- /dev/null +++ b/docs/values_and_rationale_da.md @@ -0,0 +1,16 @@ +# Open Source fra OS² + +## Værdi for forretningen og effektive driftsfordele + +##### 🇬🇧 [Read in english](../docs/values_and_rationale_en.md) + +_Indledning_ + + +1. Enkel og uafhængigt formatteret dokumentation +2. Automatiseret dokumentationsportal +3. Genbrug af hyldevarer +4. Godkendelses drevet drift +5. Transparente samarbejdsmetoder +6. Automatiseret ændringslog +7. Hurtig skabelon til udrulning diff --git a/docs/values_and_rationale_en.md b/docs/values_and_rationale_en.md new file mode 100644 index 0000000..2de5502 --- /dev/null +++ b/docs/values_and_rationale_en.md @@ -0,0 +1,3 @@ +# Open Source from OS² + +##### 🇩🇰 [Read in danish](../docs/values_and_rationale_da.md) \ No newline at end of file From 4defdc13380e6e635c085c62d4c9ad52df26c49e Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Tue, 26 Mar 2024 12:35:29 +0100 Subject: [PATCH 02/11] Section 1 and first part of section 2 added.. --- docs/values_and_rationale_da.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/docs/values_and_rationale_da.md b/docs/values_and_rationale_da.md index 8851c05..a945857 100644 --- a/docs/values_and_rationale_da.md +++ b/docs/values_and_rationale_da.md @@ -4,11 +4,36 @@ ##### 🇬🇧 [Read in english](../docs/values_and_rationale_en.md) -_Indledning_ +## 1️⃣ Enkel og uafhængigt formatteret dokumentation +_Ved at arbejde med og opbevare dokumentationen det samme sted som kildekoden bliver det lettere at vedligeholde og sikre, at dokumentationen altid er opdateret._ +>###### Anvendte standarder & teknologier: [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/) -1. Enkel og uafhængigt formatteret dokumentation -2. Automatiseret dokumentationsportal +#### 🎁 Lav Barriere for bidrag: +Bidrag til dokumentationen foregår i simple tekstdokumenter med enkel opmærkning og med frit valg imellem 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 forfattere. + + +#### ✅ Konsistens og standardisering: +Dokumentationen kan holdes i en ensartet stil og formatering på tværs af alle dokumenter. Dette gør det lettere for brugere at navigere og forstå indholdet. +Det reducerer forvirring og sikrer, at alle dokumenter følger samme standar + +#### 🔀 Sikkerhed og samarbejde: +Dokumenter versionsstyres ved siden af kildekoden, med samme værktøjskasse. Dette giver mulighed for at se hvordan dokumentationen har udviklet sig og spore ændringer. Det forbedrer gennemsigtighed og samarbejde, samt redducerer kontekstskift der gør det lige til at bidrage til dokumentationen uden afbrydelser. + +> ###### ▶️ YouTube - [Documentation as code in UK public service](https://www.youtube.com/watch?v=Ql9Il7tssik) + + +## 2️⃣ Automatiseret dokumentationsportal +_Med udnyttelse af moderne dokumenations teknologi og automatisering kan der med et minimum af arbejde leveres en ensartet udseende, åben, søgbar dokumentationsportal_ +>###### Anvendte teknologier: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub Pages]() | [Jekyll]() | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) + + + +#### 🌐 Åben adgang: +Ved at gøre dokumentationen offentligt tilgængelig via en webside der indekseres, fjernes administrations og kommunikationsopgaver forbundet med at give adgang til dokumentationen. Alle interessenter kan nemt finde og bruge den via søgemetoder og søgemaskiner. Det sparer tid og gør det lettere for alle at få adgang til dokumentationen. + +#### :medal_military: Kvalitet og pålidelighed: + Automatisk opdatering af dokumentationen hver gang der udgives nye versioner af softwaren sikrer, at dokumentationen altid er ajourført. Dette reducerer risikoen for forældet eller unøjagtig information. 3. Genbrug af hyldevarer 4. Godkendelses drevet drift 5. Transparente samarbejdsmetoder From 2bab66ba18b62b9f20eeb0630080a3343f6dd574 Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Tue, 26 Mar 2024 13:20:40 +0100 Subject: [PATCH 03/11] Added search section --- docs/values_and_rationale_da.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/values_and_rationale_da.md b/docs/values_and_rationale_da.md index a945857..e143f8d 100644 --- a/docs/values_and_rationale_da.md +++ b/docs/values_and_rationale_da.md @@ -34,6 +34,11 @@ Ved at gøre dokumentationen offentligt tilgængelig via en webside der indekser #### :medal_military: Kvalitet og pålidelighed: Automatisk opdatering af dokumentationen hver gang der udgives nye versioner af softwaren sikrer, at dokumentationen altid er ajourført. Dette reducerer risikoen for forældet eller unøjagtig information. + +#### 🔎 Indbygget hurtig søgning +Via automatisk indesering og et simpelt, globalt tilgængeligt søgefelt, foreslåes emner og afsnit der relaterer sig til de indtastede søgeord. +Dermed understøttes en hurtig og nem adgang til præcis den dokumentation anvenderne efterspørger uden behov for manuelt vedligehold af indholdsfortegnelser og emneoversigter. + 3. Genbrug af hyldevarer 4. Godkendelses drevet drift 5. Transparente samarbejdsmetoder From 801ce39ccb38dab6c1b756e1e5dfe95fb705f894 Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Tue, 26 Mar 2024 13:21:26 +0100 Subject: [PATCH 04/11] Removed colons for cleaner look --- docs/values_and_rationale_da.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/values_and_rationale_da.md b/docs/values_and_rationale_da.md index e143f8d..a3f2f45 100644 --- a/docs/values_and_rationale_da.md +++ b/docs/values_and_rationale_da.md @@ -9,15 +9,15 @@ _Ved at arbejde med og opbevare dokumentationen det samme sted som kildekoden bliver det lettere at vedligeholde og sikre, at dokumentationen altid er opdateret._ >###### Anvendte standarder & teknologier: [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/) -#### 🎁 Lav Barriere for bidrag: +#### 🎁 Lav Barriere for bidrag Bidrag til dokumentationen foregår i simple tekstdokumenter med enkel opmærkning og med frit valg imellem 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 forfattere. -#### ✅ Konsistens og standardisering: +#### ✅ Konsistens og standardisering Dokumentationen kan holdes i en ensartet stil og formatering på tværs af alle dokumenter. Dette gør det lettere for brugere at navigere og forstå indholdet. Det reducerer forvirring og sikrer, at alle dokumenter følger samme standar -#### 🔀 Sikkerhed og samarbejde: +#### 🔀 Sikkerhed og samarbejde Dokumenter versionsstyres ved siden af kildekoden, med samme værktøjskasse. Dette giver mulighed for at se hvordan dokumentationen har udviklet sig og spore ændringer. Det forbedrer gennemsigtighed og samarbejde, samt redducerer kontekstskift der gør det lige til at bidrage til dokumentationen uden afbrydelser. > ###### ▶️ YouTube - [Documentation as code in UK public service](https://www.youtube.com/watch?v=Ql9Il7tssik) @@ -29,10 +29,10 @@ _Med udnyttelse af moderne dokumenations teknologi og automatisering kan der med -#### 🌐 Åben adgang: +#### 🌐 Åben adgang Ved at gøre dokumentationen offentligt tilgængelig via en webside der indekseres, fjernes administrations og kommunikationsopgaver forbundet med at give adgang til dokumentationen. Alle interessenter kan nemt finde og bruge den via søgemetoder og søgemaskiner. Det sparer tid og gør det lettere for alle at få adgang til dokumentationen. -#### :medal_military: Kvalitet og pålidelighed: +#### :medal_military: Kvalitet og pålidelighed Automatisk opdatering af dokumentationen hver gang der udgives nye versioner af softwaren sikrer, at dokumentationen altid er ajourført. Dette reducerer risikoen for forældet eller unøjagtig information. #### 🔎 Indbygget hurtig søgning From ad8a40b985bd50e6ef8c70a8c5fb51ea116b7996 Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Tue, 26 Mar 2024 16:48:24 +0100 Subject: [PATCH 05/11] English translation added --- docs/values_and_rationale_da.md | 3 +-- docs/values_and_rationale_en.md | 35 ++++++++++++++++++++++++++++++++- 2 files changed, 35 insertions(+), 3 deletions(-) diff --git a/docs/values_and_rationale_da.md b/docs/values_and_rationale_da.md index a3f2f45..5fb5d76 100644 --- a/docs/values_and_rationale_da.md +++ b/docs/values_and_rationale_da.md @@ -12,7 +12,6 @@ _Ved at arbejde med og opbevare dokumentationen det samme sted som kildekoden bl #### 🎁 Lav Barriere for bidrag Bidrag til dokumentationen foregår i simple tekstdokumenter med enkel opmærkning og med frit valg imellem 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 forfattere. - #### ✅ Konsistens og standardisering Dokumentationen kan holdes i en ensartet stil og formatering på tværs af alle dokumenter. Dette gør det lettere for brugere at navigere og forstå indholdet. Det reducerer forvirring og sikrer, at alle dokumenter følger samme standar @@ -30,7 +29,7 @@ _Med udnyttelse af moderne dokumenations teknologi og automatisering kan der med #### 🌐 Åben adgang -Ved at gøre dokumentationen offentligt tilgængelig via en webside der indekseres, fjernes administrations og kommunikationsopgaver forbundet med at give adgang til dokumentationen. Alle interessenter kan nemt finde og bruge den via søgemetoder og søgemaskiner. Det sparer tid og gør det lettere for alle at få adgang til dokumentationen. +Ved at gøre dokumentationen offentligt tilgængelig via en webside der indekseres af eksterne søgemotorer (som f.eks Google), fjernes administrations og kommunikationsopgaver forbundet med at give adgang til dokumentationen. Alle interessenter kan nemt finde og bruge den via deres foretrukne søgemetoder og søgemaskiner. Det sparer tid og gør det lettere for alle at få adgang til dokumentationen. #### :medal_military: Kvalitet og pålidelighed Automatisk opdatering af dokumentationen hver gang der udgives nye versioner af softwaren sikrer, at dokumentationen altid er ajourført. Dette reducerer risikoen for forældet eller unøjagtig information. diff --git a/docs/values_and_rationale_en.md b/docs/values_and_rationale_en.md index 2de5502..f432559 100644 --- a/docs/values_and_rationale_en.md +++ b/docs/values_and_rationale_en.md @@ -1,3 +1,36 @@ # Open Source from OS² -##### 🇩🇰 [Read in danish](../docs/values_and_rationale_da.md) \ No newline at end of file +## Businessvalue and effective operating benefits + +##### 🇩🇰 [Read in danish](../docs/values_and_rationale_da.md) + +## 1️⃣ Simple and independently formatted documentation +_By working with and storing the documentation in the same place as the source code, it becomes easier to maintain and ensure that the documentation is always up to date._ +###### Standards & technologies used: [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 + +#### 🔀 Security 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. + +> ###### ▶️ YouTube - [Documentation as code in UK public service](https://www.youtube.com/watch?v=Ql9Il7tssik) + + +## 2️⃣ Automated documentation portal +_Using modern documentation technology and automation, a uniform appearance, open, searchable documentation portal can be delivered with a minimum of work_ +####### Technologies used: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub Pages]() | [Jekyll]() | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) + +#### 🌐 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. + +#### :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. + +#### 🔎 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. \ No newline at end of file From 2b7ee69c129ac40588791217361c46151d5c2f0d Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Fri, 5 Apr 2024 14:56:42 +0200 Subject: [PATCH 06/11] EN additions --- docs/values_and_rationale_da.md | 12 +++++++---- docs/values_and_rationale_en.md | 36 ++++++++++++++++++++++++++++++--- 2 files changed, 41 insertions(+), 7 deletions(-) diff --git a/docs/values_and_rationale_da.md b/docs/values_and_rationale_da.md index 5fb5d76..80fc01a 100644 --- a/docs/values_and_rationale_da.md +++ b/docs/values_and_rationale_da.md @@ -5,7 +5,7 @@ ##### 🇬🇧 [Read in english](../docs/values_and_rationale_en.md) -## 1️⃣ Enkel og uafhængigt formatteret dokumentation +## Enkel og uafhængigt formatteret dokumentation _Ved at arbejde med og opbevare dokumentationen det samme sted som kildekoden bliver det lettere at vedligeholde og sikre, at dokumentationen altid er opdateret._ >###### Anvendte standarder & teknologier: [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/) @@ -22,7 +22,7 @@ Dokumenter versionsstyres ved siden af kildekoden, med samme værktøjskasse. De > ###### ▶️ YouTube - [Documentation as code in UK public service](https://www.youtube.com/watch?v=Ql9Il7tssik) -## 2️⃣ Automatiseret dokumentationsportal +## Automatiseret dokumentationsportal _Med udnyttelse af moderne dokumenations teknologi og automatisering kan der med et minimum af arbejde leveres en ensartet udseende, åben, søgbar dokumentationsportal_ >###### Anvendte teknologier: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub Pages]() | [Jekyll]() | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) @@ -38,8 +38,12 @@ Ved at gøre dokumentationen offentligt tilgængelig via en webside der indekser Via automatisk indesering og et simpelt, globalt tilgængeligt søgefelt, foreslåes emner og afsnit der relaterer sig til de indtastede søgeord. Dermed understøttes en hurtig og nem adgang til præcis den dokumentation anvenderne efterspørger uden behov for manuelt vedligehold af indholdsfortegnelser og emneoversigter. -3. Genbrug af hyldevarer -4. Godkendelses drevet drift + +## 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 diff --git a/docs/values_and_rationale_en.md b/docs/values_and_rationale_en.md index f432559..d7c6b7d 100644 --- a/docs/values_and_rationale_en.md +++ b/docs/values_and_rationale_en.md @@ -18,12 +18,13 @@ It reduces confusion and ensures that all documents follow the same standard #### 🔀 Security 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. -> ###### ▶️ YouTube - [Documentation as code in UK public service](https://www.youtube.com/watch?v=Ql9Il7tssik) +###### ▶️ YouTube - [Documentation as code in UK public service](https://www.youtube.com/watch?v=Ql9Il7tssik) ## 2️⃣ Automated documentation portal _Using modern documentation technology and automation, a uniform appearance, open, searchable documentation portal can be delivered with a minimum of work_ -####### Technologies used: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub Pages]() | [Jekyll]() | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) + +###### Technologies used: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub Pages]() | [Jekyll]() | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) #### 🌐 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. @@ -33,4 +34,33 @@ Automatic updating of the documentation every time new versions of the software #### 🔎 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. \ No newline at end of file +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. + +## Cheaper better software to build and to run by reuse + + +0 licensing fees, easier and thus cheeper to adapt, longterm +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. + +#### Security: + Open source software (OSS) is developed by a large community, making it more secure. It’s rigorously tested and vulnerabilities are patched quickly. + +#### Flexibility and Agility: + OSS allows businesses to quickly adapt to changes, customize software to their needs, and scale their infrastructure. + +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. + +Cost: OSS is often free or cheaper than proprietary solutions, with no ongoing licensing fees. The Total +Cost of Ownership (TCO) is typically lower. + +Higher Quality Software: 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. + +Works in the Cloud: OSS is designed to work in the cloud, making it ideal for hybrid cloud architectures. + +Time to Market: OSS often has a shorter time to market as it’s simpler and easier to implement. + +Transparency: OSS is built on transparency and collaboration, instilling trust in digital infrastructure. + +Interoperability: OSS is usually compatible with other software applications, making it easier to integrate into various systems and saving time and money. From c63432f21297f37c42e76d3b0e58d1c9be3fe80c Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Mon, 8 Apr 2024 14:28:32 +0200 Subject: [PATCH 07/11] rationales improved --- docs/values_and_rationale_en.md | 66 ++++++++++++++++++++++----------- 1 file changed, 44 insertions(+), 22 deletions(-) diff --git a/docs/values_and_rationale_en.md b/docs/values_and_rationale_en.md index d7c6b7d..62a7e18 100644 --- a/docs/values_and_rationale_en.md +++ b/docs/values_and_rationale_en.md @@ -4,7 +4,7 @@ ##### 🇩🇰 [Read in danish](../docs/values_and_rationale_da.md) -## 1️⃣ Simple and independently formatted documentation +## 1️⃣ Ensuring Consistent & Relevant Documentation _By working with and storing the documentation in the same place as the source code, it becomes easier to maintain and ensure that the documentation is always up to date._ ###### Standards & technologies used: [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/) @@ -15,14 +15,11 @@ Contributions to the documentation take place in simple text documents with simp 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 -#### 🔀 Security and cooperation +#### 🔀 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. -###### ▶️ YouTube - [Documentation as code in UK public service](https://www.youtube.com/watch?v=Ql9Il7tssik) - - -## 2️⃣ Automated documentation portal -_Using modern documentation technology and automation, a uniform appearance, open, searchable documentation portal can be delivered with a minimum of work_ +## 2️⃣ Open access to streaminlined searchable documentation +_Using modern documentation technology and automation, open, searchable documentation is delivered with a minimum of work_ ###### Technologies used: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub Pages]() | [Jekyll]() | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) @@ -36,31 +33,56 @@ Automatic updating of the documentation every time new versions of the software 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. -## Cheaper better software to build and to run by reuse +## 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. + +- Improvec 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. + -0 licensing fees, easier and thus cheeper to adapt, longterm + + +#### 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. -#### Security: - Open source software (OSS) is developed by a large community, making it more secure. It’s rigorously tested and vulnerabilities are patched quickly. -#### Flexibility and Agility: - OSS allows businesses to quickly adapt to changes, customize software to their needs, and scale their infrastructure. -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. +#### Quality: +OSS taps into a global pool of talent, leading to better code and quick bug fixes. -Cost: OSS is often free or cheaper than proprietary solutions, with no ongoing licensing fees. The Total -Cost of Ownership (TCO) is typically lower. +#### 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. -Higher Quality Software: OSS taps into a global pool of talent, leading to better code and quick bug fixes. +#### 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. -Safely Leverage Advanced Tech: OSS allows businesses to leverage advanced tech and have access to the latest innovations. +#### 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. -Works in the Cloud: OSS is designed to work in the cloud, making it ideal for hybrid cloud architectures. +#### 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. -Time to Market: OSS often has a shorter time to market as it’s simpler and easier to implement. -Transparency: OSS is built on transparency and collaboration, instilling trust in digital infrastructure. -Interoperability: OSS is usually compatible with other software applications, making it easier to integrate into various systems and saving time and money. From 8be9acc1c0014bafc2c1588c93e4e499f374bfe0 Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Tue, 9 Apr 2024 11:35:57 +0200 Subject: [PATCH 08/11] Added --- docs/values_and_rationale_en.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/values_and_rationale_en.md b/docs/values_and_rationale_en.md index 62a7e18..03a8da9 100644 --- a/docs/values_and_rationale_en.md +++ b/docs/values_and_rationale_en.md @@ -4,7 +4,7 @@ ##### 🇩🇰 [Read in danish](../docs/values_and_rationale_da.md) -## 1️⃣ Ensuring Consistent & Relevant Documentation +## Low barriers for transparency and consistency in the documentation process _By working with and storing the documentation in the same place as the source code, it becomes easier to maintain and ensure that the documentation is always up to date._ ###### Standards & technologies used: [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/) @@ -18,21 +18,22 @@ 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. -## 2️⃣ Open access to streaminlined searchable documentation -_Using modern documentation technology and automation, open, searchable documentation is delivered with a minimum of work_ +## Streamlined current 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 used: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub Pages]() | [Jekyll]() | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) +###### 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. -#### :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. - #### 🔎 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/) From 4ef90fdbc468e446cc43549eb50106d60e43cb4c Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Tue, 9 Apr 2024 12:50:59 +0200 Subject: [PATCH 09/11] Translations and rewrite --- docs/values_and_rationale_da.md | 42 ++++++++++++++------------------- docs/values_and_rationale_en.md | 13 +++++----- 2 files changed, 25 insertions(+), 30 deletions(-) diff --git a/docs/values_and_rationale_da.md b/docs/values_and_rationale_da.md index 80fc01a..e81b422 100644 --- a/docs/values_and_rationale_da.md +++ b/docs/values_and_rationale_da.md @@ -1,43 +1,37 @@ # Open Source fra OS² -## Værdi for forretningen og effektive driftsfordele +## 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._ -## Enkel og uafhængigt formatteret dokumentation -_Ved at arbejde med og opbevare dokumentationen det samme sted som kildekoden bliver det lettere at vedligeholde og sikre, at dokumentationen altid er opdateret._ ->###### Anvendte standarder & teknologier: [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/) +###### 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 opmærkning og med frit valg imellem 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 forfattere. +#### 🎁 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 lettere for brugere at navigere og forstå indholdet. -Det reducerer forvirring og sikrer, at alle dokumenter følger samme standar +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. -#### 🔀 Sikkerhed og samarbejde -Dokumenter versionsstyres ved siden af kildekoden, med samme værktøjskasse. Dette giver mulighed for at se hvordan dokumentationen har udviklet sig og spore ændringer. Det forbedrer gennemsigtighed og samarbejde, samt redducerer kontekstskift der gør det lige til at bidrage til dokumentationen uden afbrydelser. - -> ###### ▶️ YouTube - [Documentation as code in UK public service](https://www.youtube.com/watch?v=Ql9Il7tssik) - - -## Automatiseret dokumentationsportal -_Med udnyttelse af moderne dokumenations teknologi og automatisering kan der med et minimum af arbejde leveres en ensartet udseende, åben, søgbar dokumentationsportal_ ->###### Anvendte teknologier: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) | [GitHub Pages]() | [Jekyll]() | [JustTheDocs](https://just-the-docs.github.io/just-the-docs/) +#### 🔀 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 offentligt tilgængelig via en webside der indekseres af eksterne søgemotorer (som f.eks Google), fjernes administrations og kommunikationsopgaver forbundet med at give adgang til dokumentationen. Alle interessenter kan nemt finde og bruge den via deres foretrukne søgemetoder og søgemaskiner. Det sparer tid og gør det lettere for alle at få adgang til dokumentationen. +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. -#### :medal_military: Kvalitet og pålidelighed - Automatisk opdatering af dokumentationen hver gang der udgives nye versioner af softwaren sikrer, at dokumentationen altid er ajourført. Dette reducerer risikoen for forældet eller unøjagtig information. - -#### 🔎 Indbygget hurtig søgning -Via automatisk indesering og et simpelt, globalt tilgængeligt søgefelt, foreslåes emner og afsnit der relaterer sig til de indtastede søgeord. -Dermed understøttes en hurtig og nem adgang til præcis den dokumentation anvenderne efterspørger uden behov for manuelt vedligehold af indholdsfortegnelser og emneoversigter. +#### 🔎 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 diff --git a/docs/values_and_rationale_en.md b/docs/values_and_rationale_en.md index 03a8da9..5d7b566 100644 --- a/docs/values_and_rationale_en.md +++ b/docs/values_and_rationale_en.md @@ -1,12 +1,13 @@ # Open Source from OS² -## Businessvalue and effective operating benefits +## 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 working with and storing the documentation in the same place as the source code, it becomes easier to maintain and ensure that the documentation is always up to date._ -###### Standards & technologies used: [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 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. @@ -18,10 +19,10 @@ 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 current documentation with open access and built in search +## 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) +###### 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. From 0495e7655c52a5aeb54e87aac0f628d8692e0f31 Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Tue, 9 Apr 2024 14:59:25 +0200 Subject: [PATCH 10/11] Additions and translations --- docs/values_and_rationale_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/values_and_rationale_en.md b/docs/values_and_rationale_en.md index 5d7b566..9fe377e 100644 --- a/docs/values_and_rationale_en.md +++ b/docs/values_and_rationale_en.md @@ -1,6 +1,6 @@ # Open Source from OS² -## Business values and effective operational advantages across applications +## Uniform business values and effective operational advantages across applications ##### 🇩🇰 [Read in danish](../docs/values_and_rationale_da.md) From 4e3b9302cf0b53f1e58007c7b4eb0f0b4ba9925c Mon Sep 17 00:00:00 2001 From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com> Date: Tue, 9 Apr 2024 14:59:33 +0200 Subject: [PATCH 11/11] Additional changes - work in progress --- docs/values_and_rationale_en.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/docs/values_and_rationale_en.md b/docs/values_and_rationale_en.md index 9fe377e..594126e 100644 --- a/docs/values_and_rationale_en.md +++ b/docs/values_and_rationale_en.md @@ -40,30 +40,25 @@ Automatic updating of the documentation every time new versions of the software ###### 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. +#### 📤 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. - -- Improvec 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. +#### 🛡️ 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. - -#### Quality: -OSS taps into a global pool of talent, leading to better code and quick bug fixes. - #### 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.