doc: Update documents for v3.0.0 (#20)

* doc: Update documents for v3.0.0 Signed-off-by: Brian McGinn <brian.mcginn@intel.com> --------- Signed-off-by: Brian McGinn <brian.mcginn@intel.com>
intel-retail · May 3, 2024 · a80114d · a80114d
1 parent 04899e6
commit a80114d
Show file tree

Hide file tree

Showing 114 changed files with 19,010 additions and 34 deletions.
diff --git a/docs_src/CODE_OF_CONDUCT.md → .github/CODE_OF_CONDUCT.md b/docs_src/CODE_OF_CONDUCT.md → .github/CODE_OF_CONDUCT.md
diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -0,0 +1,72 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard Retail Documentation
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '0 0 * * 6' # Run at 00:00 Friday UTC
+  push:
+    branches: [ "main" ]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      # Uncomment the permissions below if installing in a private repository.
+      # contents: read
+      # actions: read
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # 2.3.1
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecard on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard.
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@17573ee1cc1b9d061760f3a006fc4aac4f944fd5 # v2.2.4
+        with:
+          sarif_file: results.sarif
diff --git a/docs_src/CONTRIBUTING.md → CONTRIBUTING.md b/docs_src/CONTRIBUTING.md → CONTRIBUTING.md
diff --git a/docs_src/LICENSE → LICENSE b/docs_src/LICENSE → LICENSE
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Intel Retail Documentation Repository
+
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/intel-retail/documentation/badge)](https://api.securityscorecards.dev/projects/github.com/intel-retail/documentation)
+[![GitHub Latest Stable Tag](https://img.shields.io/github/v/tag/intel-retail/documentation?sort=semver&label=latest-stable)](https://github.com/intel-retail/documentation/releases)
+[![Discord](https://discord.com/api/guilds/1150892043120414780/widget.png?style=shield)](https://discord.gg/ZHgtrZcu)
+
+![Requirements Review Process Flow](./docs_src/requirements-review-process-flow.png)
+
+## Requirements Process Breakdown
+
+- Submit a Github issue and follow the requirements template.
+
+- Once a every (x) weeks there will be a requirements review meeting where we will approve, reject, or ask for modification to the requirement.
+
+- If approved then the requirement will be moved into the design stage in the documents project.
+
+- A detailed design document will be made by the submitter and development team.
+
+- A pull request will be created and reviewed by the design review team. The design will be iterated until approved by the board.
+
+- Once approved a story will be created in the appropriate Github project and prioritized by the product owner.
+
+- Story work will be completed based on the prioritization.
+
+## [Intel Retail Documentation](https://intel-retail.github.io/documentation/)
+
+## Join the community 
+[![Discord Banner 1](https://discordapp.com/api/guilds/1150892043120414780/widget.png?style=banner2)](https://discord.gg/ZHgtrZcu)