docs: adding documentation as open source preparation

Author: nexus49

.github/workflows/deploy.yml

@@ -18,12 +18,10 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 18
-          cache: yarn
-
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
+        run: npm ci
       - name: Build website
-        run: yarn build
+        run: npm run build
 
       - name: Upload Build Artifact
         uses: actions/upload-pages-artifact@v3

.github/workflows/licenses.yml

@@ -0,0 +1,18 @@
+name: "Update License Metadata"
+
+on:
+  push:
+    branches: [ "main" ]
+  schedule:
+    - cron: '32 16 * * 0'
+
+jobs:
+  license:
+    concurrency:
+      group: license-${{ github.ref }}
+      cancel-in-progress: true
+    permissions:
+      contents: write
+      pull-requests: write
+    uses: openmfp/gha/.github/workflows/job-license-metadata.yml@main
+    secrets: inherit

CODEOWNERS

@@ -0,0 +1,4 @@
+# Default code owners
+* @openmfp/frame
+go.mod
+go.sum

CODE_OF_CONDUCT.md

@@ -0,0 +1,86 @@
+# SAP Open Source Code of Conduct
+
+SAP adopts the [Contributor's Covenant 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)
+across our open source projects to ensure a welcoming and open culture for everyone involved.
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]) (SAP Open Source Program Office). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+## Overview
+
+# Contributing to openMFP
+We want to make contributing to this project as easy and transparent as possible.
+
+## Our development process
+We use GitHub to track issues and feature requests, as well as accept pull requests.
+
+## Pull requests
+You are welcome to contribute with your pull requests. These steps explain the contribution process:
+
+1. Fork the repository and create your branch from `main`.
+1. Verify and test your changes see [testing](#testing).
+1. Sign the Developer Certificate of Origin (DCO).
+
+## Testing
+- Make sure the website builds as expected by running `npm run build` in the root directory of the repository.
+- Make sure your changes render as expected in the browser, you can test the website locally by running `npm start` in the root directory of the repository.
+
+## Issues
+We use GitHub issues to track bugs. Please ensure your description is
+clear and includes sufficient instructions to reproduce the issue.
+
+## License
+By contributing to openMFP, you agree that your contributions will be licensed
+under its [Apache-2.0 license](LICENSE).

LICENSE

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -1,41 +1,28 @@
-# Website
+# OpenMFP - Website and Documentation
 
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+This Repository contains the OpenMFP Website and Documentation. This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
-### Installation
+## Releasing
 
-```
-$ yarn
-```
+The release is performed automatically through a GitHub Actions Workflow. The resulting website will be available as github page under the following URL: https://openmfp.github.io/openmfp.org/
 
-### Local Development
+## Requirements
 
-```
-$ yarn start
-```
+The website requires an installation of node.js and npm.
+Checkout the [package.json](package.json) for the required node version and dependencies and install them via `npm install`.
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+## Security / Disclosure
+If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/openmfp/openmfp.org/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
 
-### Build
+## Contributing
 
-```
-$ yarn build
-```
+Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for instructions on how to contribute to OpenMFP.
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+## Code of Conduct
 
-### Deployment
+Please refer to the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file in this repository for information on the expected Code of Conduct for contributing to OpenMFP.
 
-Using SSH:
+## Licensing
 
-```
-$ USE_SSH=true yarn deploy
-```
+Copyright 2024 SAP SE or an SAP affiliate company and OpenMFP contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/openmfp/openmfp.org).
 
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

package-lock.json

@@ -42,6 +42,7 @@
     ]
   },
   "engines": {
-    "node": ">=18.0"
+    "node": ">=20.0.0",
+    "npm": ">=9.0.0"
   }
 }