Skip to content

Commit

Permalink
revamp readme to point to relevant resources
Browse files Browse the repository at this point in the history
The readme was written a long time ago and had outdated pointers.
This patch re-organizes and adds in relevant pointers in the readme.
  • Loading branch information
hbagdi committed Oct 29, 2020
1 parent 6d20ee7 commit 9951277
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 15 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright {yyyy} {name of copyright owner}
Copyright 2020 The Kubernetes Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
50 changes: 36 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,39 @@
# Kubernetes Service/Ingress API evolution
# Kubernetes Service APIs

The Service APIs group is a part of the [Networking SIG][sn], and this repository is the home of the Kubernetes Service/Ingress API evolution work.
The Service APIs is a part of the [SIG Network][sn], and this repository
contains the specification and Custom Resource Definitions (CRDs).

- The goal of this group is to flesh out and extend the original concepts in the [API sketch][apisketch] which was completed in September of 2019 by members of the sig-network group.
- [The primary documentation is available here in Github Pages][ghp], and is still heavily under development.
## Documentation

[ghp]: https://kubernetes-sigs.github.io/service-apis/
[apisketch]: https://docs.google.com/document/d/1BxYbDovMwnEqe8lj8JwHo8YxHAt3oC7ezhlFsG_tyag/preview#
[sn]: https://github.com/kubernetes/community/tree/master/sig-network
### Website

## Community, discussion, contribution, and support
The API specification and detailed documentation is available on the project
website: [https://kubernetes-sigs.github.io/service-apis][ghp].

[Our community meeting schedule is here][cm].
### Get started

[cm]: https://kubernetes-sigs.github.io/service-apis/community
To get started, please read through [API concepts](concepts.md) and
[Security model](security-model.md). These documents give the necessary background
to understand the API and the use-cases it targets.

### Guides

Once you have a good understanding of the API at a higher-level, please
follow one of our [guides](guides.md) to dive deeper into different parts of
the API.

### References

A complete API reference, please refer to:

Our Kubernetes Slack channel is [#sig-network-service-apis](https://kubernetes.slack.com/messages/sig-network-service-apis).
- [API reference](spec.md)
- [Go docs for the package](https://pkg.go.dev/sigs.k8s.io/service-apis/apis/v1alpha1)

## Contributing

Community meeting schedule, notes and developer guide can be found on the
[community page][cm].
Our Kubernetes Slack channel is [#sig-network-service-apis][slack].

## Technical Leads

Expand All @@ -24,7 +42,11 @@ Our Kubernetes Slack channel is [#sig-network-service-apis](https://kubernetes.s

### Code of conduct

Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
Participation in the Kubernetes community is governed by the
[Kubernetes Code of Conduct](code-of-conduct.md).

[ghp]: https://kubernetes-sigs.github.io/service-apis/
[sn]: https://github.com/kubernetes/community/tree/master/sig-network
[cm]: https://kubernetes-sigs.github.io/service-apis/community
[slack]: https://kubernetes.slack.com/messages/sig-network-service-apis

[owners]: https://git.k8s.io/community/contributors/guide/owners.md
[Creative Commons 4.0]: https://git.k8s.io/website/LICENSE

0 comments on commit 9951277

Please sign in to comment.