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.

Sign up for GitHub

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

docs: update README.md #31

Merged
merged 1 commit into from
Jan 9, 2024
Merged

docs: update README.md #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 41 additions & 35 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,33 @@ Old working document of the [charter](https://docs.google.com/document/d/1w_lo2R

<!-- https://contribute.cncf.io/maintainers/governance/charter/ -->

The CNCF Artifacts Working Group is under the App Delivery Technical Advisory Group hosted by the [Cloud Native Computing Foundation (CNCF)](https://cncf.io).

`https://github.com/cncf/tag-app-delivery/tree/main/artifacts-wg`
The CNCF Artifacts Working Group is under the [App Delivery Technical Advisory Group](https://github.com/cncf/tag-app-delivery/tree/main/artifacts-wg) hosted
by the [Cloud Native Computing Foundation (CNCF)](https://cncf.io).

## Chairs

- Alex Flom (@afflom)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be updated based on cncf/tag-app-delivery#516?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made this a separate PR
#32

- Ramkumar Chinchani (@rchincha)

## Use Cases

<!-- embed docs/use-cases.md -->

A list of common use cases that are implemented across various package managers.

<!--- | Alpine | Cargo | Carvel | Helm | Maven | npm | OCI | PyPi | rpm | --->
<!-- markdownlint-disable-next-line MD033 -->
| Use Case /<BR>Package Manager | [Alpine](./pkgmgr/alpine.md) </BR>(APK) | Cargo | Carvel | Helm | Maven | npm | [OCI](./pkgmgr/oci.md) | [PyPi](./pkgmgr/pypi.md) | rpm |
| - | - | - | - | - | - | - | - | - | - |
| **[List of Packages](docs/use-cases.md#list-of-packages)** | :green_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :red_circle:* | :green_circle: | :white_circle: |
| **[Filter a List of Packages](docs/use-cases.md#filter-a-list-of-packages)** | :green_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :red_circle: | :yellow_circle: | :white_circle: |
| **[List versions](docs/use-cases.md#list-versions)** | :red_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :yellow_circle:*| :green_circle: | :white_circle: |
| **[De-dupability](docs/use-cases.md#de-dupability)** | :yellow_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :green_circle: | :green_circle: | :white_circle: |
| **[Multi-Arch Support](docs/use-cases#multi-architecture-support)** | :green_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :green_circle: | :green_circle: | :white_circle: |
| **[Dependency Tracking](docs/use-cases.md#dependency-tracking)** | :green_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :green_circle: | :green_circle: | :white_circle: |
| **\<use-case\>** | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :white_circle: | :yellow_circle: | :white_circle: |
<!--- | Alpine | Cargo | Carvel | Helm | Maven | npm | OCI | PyPi | rpm | --->

## Getting Started

<!-- Include enough details to get started using, or at least building, the
Expand All @@ -51,6 +69,21 @@ include:
* basic prerequisites
-->

Currently, the working group is evaluating the current state of various
software ecosystems and whether it is feasible to standardize and also
suggest changes.

```bash
# Clone this repository
git clone https://github.com/cncf-tags/wg-artifacts.git

# Enter cloned dir
cd wg-artifacts

# Check metadata query support across software ecosystems
make conformance
```

## Contributing
<!-- Template: https://github.com/cncf/project-template/blob/main/CONTRIBUTING.md -->

Expand All @@ -64,27 +97,7 @@ started contributing, please see our [Contributor Guide](CONTRIBUTING.md).
<!-- More information about creating your scope with links to examples -->
<!-- https://contribute.cncf.io/maintainers/governance/charter/ -->

### In Scope

[TODO: PROJECTNAME] is intended to [TODO: Core functionality]. As such, the
project will implement or has implemented:

- [TODO: High-level Item 1]
- [TODO: High-level Item 2]
- [TODO: High-level Item 3]

### Out of Scope

[TODO: PROJECTNAME] will be used in a cloud native environment with other
tools. The following specific functionality will therefore not be incorporated:

- [TODO: Excluded function 1]
- [TODO: Excluded function 2]

[TODO: PROJECTNAME] implements [TODO: List of major features, existing or
planned], through [TODO: Implementation
requirements/language/architecture/etc.]. It will not cover [TODO: short list
of excluded items]
- Define a set of query interfaces that can standardized across various software ecosystems.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing ### In Scope section header

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed that for now. Once things are more clear, we can add that again (at least that is my plan)
Less clutter!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know if you or others disagree.


## Communications

Expand All @@ -93,10 +106,6 @@ can join, and there should be several ways that users and contributors can reach
If you have recurring/regular meetings, list those or a link to a publicy-readable calendar so that
prospective contributors know when and where to engage with you. -->

[TODO: Details (with links) to meetings, mailing lists, Slack, and any other communication channels]

- User Mailing List:
- Developer Mailing List:
- Slack Channel:

[Slack channel](https://cloud-native.slack.com/archives/C04UQDWS4M7)
Expand All @@ -105,27 +114,24 @@ prospective contributors know when and where to engage with you. -->

This working group meets on 2nd and 4th Friday of each month @ 1700 UTC

Zoom: https://zoom.us/j/7276783015?pwd=R0RJMkRzQ1ZjcmE0WERGcTJTOEVyUT09
Passcode: 77777
Zoom: [https://zoom.us/j/7276783015?pwd=R0RJMkRzQ1ZjcmE0WERGcTJTOEVyUT09](https://zoom.us/j/7276783015?pwd=R0RJMkRzQ1ZjcmE0WERGcTJTOEVyUT09)
Passcode: 77777

Agendas and notes: https://docs.google.com/document/d/1E7iKPOuyA1jxPe8vDG8aPd8jtnCEbpDpCifXDvDCnA0/
Agendas and notes: [https://docs.google.com/document/d/1E7iKPOuyA1jxPe8vDG8aPd8jtnCEbpDpCifXDvDCnA0/](https://docs.google.com/document/d/1E7iKPOuyA1jxPe8vDG8aPd8jtnCEbpDpCifXDvDCnA0/)

[CNCF Community](https://community.cncf.io/tag-app-delivery/)

WG Artifacts - Project Meeting
TAG App Delivery

- Social Media:
- Other Channel(s), If Any:

## Resources

[Meeting Notes](https://docs.google.com/document/d/1E7iKPOuyA1jxPe8vDG8aPd8jtnCEbpDpCifXDvDCnA0/)

## License

<!-- Template: https://github.com/cncf/project-template/blob/main/LICENSE -->
This project is licensed under [TODO: Add name of license and link to your LICENSE file]
This project is licensed under [Apache 2.0](LICENSE)

## Conduct

Expand Down