Skip to content

Commit

Permalink
Update and lint files
Browse files Browse the repository at this point in the history
Signed-off-by: Taylor Dolezal <[email protected]>
  • Loading branch information
onlydole committed Nov 25, 2022
1 parent aca7646 commit ccf2e64
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/workflows/linkchecker.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
name: "Code Quality: Link Checker"

on:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/superlinter.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
name: "Code Quality: Super-Linter"

on:
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Score

![Score banner](/docs/images/banner.png)

## ![Score](/docs/images/logo.svg) What is Score?
Expand Down
10 changes: 7 additions & 3 deletions roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,18 @@

## Generalized Score extension mechanism

The Score Specification allows developers to define the main characteristics of their Workload. It reduces cognitive load by providing sensible defaults, meaning it only exposes the most important and commonly utilized properties of a Workload's definition. At the same time, should the spec be able to accommodate any additional configuration options that are needed by its users. The implementation of a generalized extension mechanism allows users to extend their `score.yaml` files with properties that are not included as part of the core Workload specification.
The Score Specification allows developers to define the main characteristics of their Workload. It reduces cognitive load by providing sensible defaults, meaning it only exposes the most important and commonly utilized properties of a Workload's definition. At the same time, should the spec be able to accommodate any additional configuration options that are needed by its users.
The implementation of a generalized extension mechanism allows users to extend their `score.yaml` files with properties that are not included as part of the core Workload specification.

## Score implementation CLIs

As a platform-agnostic Workload specification, the Score Spec integrates with many container orchestration platforms. To expose its full potential, additional implementations for popular tooling such as Kustomize, Amazon ECS, Google Cloud Run, or Nomad are needed. This would allow an increasing amount of users to integrate Score into their existing tech stack, or migrate to a different tech stack without additional engineering effort.
As a platform-agnostic Workload specification, the Score Spec integrates with many container orchestration platforms. To expose its full potential, additional implementations for popular tooling such as Kustomize, Amazon ECS, Google Cloud Run, or Nomad are needed.
This would allow an increasing amount of users to integrate Score into their existing tech stack, or migrate to a different tech stack without additional engineering effort.

## Score Developer Documentation

The developer documentation [docs.score.dev](https://docs.score.dev/docs/) plays a crucial role in onboarding new users to Score and supporting them in their day-to-day usage. To be helpful for users of all experiences and for a variety of use cases, additional documentation in the form of real-world usage examples, tutorials, demos, and educational material on underlying concepts such as containers, container orchestration platforms, CLI tooling and similar is needed. With this, a smooth onboarding experience that defines clear learning paths forward can be provided for Score's users.
The developer documentation [docs.score.dev](https://docs.score.dev/docs/) plays a crucial role in onboarding new users to Score and supporting them in their day-to-day usage.
To be helpful for users of all experiences and for a variety of use cases, additional documentation in the form of real-world usage examples, tutorials, demos, and educational material on underlying concepts such as containers, container orchestration platforms, CLI tooling and similar is needed.
With this, a smooth onboarding experience that defines clear learning paths forward can be provided for Score's users.

For reference and status updates on the roadmap, please check the [roadmap project](https://github.com/orgs/score-spec/projects/1). You can submit an idea anytime [here](https://github.com/score-spec/spec/issues/new).

0 comments on commit ccf2e64

Please sign in to comment.