Sync README.md

Author: tas-runtime-bot

README.md

@@ -1,74 +1,50 @@
-# BBS Server [![GoDoc](https://godoc.org/github.com/cloudfoundry/bbs?status.svg)](https://godoc.org/github.com/cloudfoundry/bbs)
-
-**Note**: This repository should be imported as `code.cloudfoundry.org/bbs`.
-
-API to access the database for Diego.
-
-A general overview of the BBS is documented [here](doc).
-
-## Reporting issues and requesting features
-
-Please report all issues and feature requests in [cloudfoundry/diego-release](https://github.com/cloudfoundry/diego-release/issues).
-
-## API
-
-To interact with the BBS from outside of Diego, use the methods provided on the
-[`Client` interface](https://godoc.org/github.com/cloudfoundry/bbs#Client).
-
-Components within Diego may use the full [`InternalClient`
-interface](https://godoc.org/github.com/cloudfoundry/bbs#InternalClient) to modify internal state.
-
-## Code Generation
-
-The protobuf models in this repository require version 3.5 or later of the `protoc` compiler.
-
-### OSX
-
-On Mac OS X with [Homebrew](http://brew.sh/), run the following to install it:
-
-```
-brew install protobuf
-```
-
-### Linux
-
-1. Download a zip archive of the latest protobuf release from [here](https://github.com/google/protobuf/releases).
-1. Unzip the archive in `/usr/local` (including /bin and /include folders).
-1. `chmod a+x /usr/local/bin/protoc` to make sure you can use the binary.
-
-> If you already have an older version of protobuf installed, you must
-> uninstall it first by running `brew uninstall protobuf`
-
-Install the `gogoproto` compiler by running:
-
-```
-go install github.com/gogo/protobuf/protoc-gen-gogoslick
-```
-
-Run `go generate ./...` from the root directory of this repository to generate code from the `.proto` files as well as to generate fake implementations of certain interfaces for use in test code.
-
-### Generating ruby models for BBS models
-
-The following documentation assume the following versions:
-
-1. [protoc](https://github.com/google/protobuf/releases) `> v3.5.0`
-2. [ruby protobuf gem](https://github.com/ruby-protobuf/protobuf) `> 3.6.12`
-
-Run the following commands from the `models` directory to generate `.pb.rb`
-files for the BBS models:
-
-1. `sed -i'' -e 's/package models/package diego.bbs.models/' ./*.proto`
-1. `protoc -I../../vendor --proto_path=. --ruby_out=/path/to/ruby/files *.proto`
-
-**Note** Replace `/path/to/ruby/files` with the desired destination of the
-`.pb.rb` files. That directory must exist before running this command.
-
-**Note** The above steps assume that
-`github.com/gogo/protobuf/gogoproto/gogo.proto` is on the `GOPATH`.
-
-## SQL
-See [Migrations](https://github.com/cloudfoundry/bbs/blob/master/doc/bbs-migration.md) for information about writing database migrations.
-
-## Run Tests
-See the instructions in [the Diego Release contributing guide](https://github.com/cloudfoundry/diego-release/blob/develop/.github/CONTRIBUTING.md#running-tests)
-for how to run all tests
+# BBS
+
+Bulletin Board System (BBS) is the API to access the database for Diego.
+It communicates via protocol-buffer-encoded RPC-style calls over HTTP.
+
+> \[!NOTE\]
+>
+> This repository should be imported as `code.cloudfoundry.org/bbs`.
+
+# Docs
+
+-   [BBS API Overview](./docs/010-overview.md)
+-   [The components of a Diego Cell overview](./docs/011-cells.md)
+-   [Cells API](./docs/012-api-cells.md)
+-   [Overview of Tasks](./docs/020-tasks.md)
+-   [Defining Tasks](./docs/021-defining-tasks.md)
+-   [Task Examples](./docs/022-task-examples.md)
+-   [Tasks API](./docs/023-api-tasks.md)
+-   [Tasks Internal API](./docs/024-api-tasks-internal.md)
+-   [Overview of LRPs: Long Running Processes](./docs/030-lrps.md)
+-   [Defining LRPs](./docs/031-defining-lrps.md)
+-   [LRP Examples](./docs/032-lrp-examples.md)
+-   [LRP API Reference](./docs/033-api-lrps.md)
+-   [Actual LRPs Internal API](./docs/034-api-lrps-internal.md)
+-   [BBS DB Schema](./docs/040-schema-description.md)
+-   [BBS API Versioning
+    Conventions](./docs/041-revisioning-bbs-api-endpoints.md)
+-   [BBS Migrations](./docs/042-bbs-migration.md)
+-   [Domains](./docs/050-domains.md)
+-   [Container Runtime Environment Variables](./docs/051-environment.md)
+-   [BBS Events](./docs/052-events.md)
+-   [Actions](./docs/053-actions.md)
+-   [BBS Models](./docs/054-common-models.md)
+
+# Contributing
+
+See the [Contributing.md](./.github/CONTRIBUTING.md) for more
+information on how to contribute.
+
+# Working Group Charter
+
+This repository is maintained by [App Runtime
+Platform](https://github.com/cloudfoundry/community/blob/main/toc/working-groups/app-runtime-platform.md)
+under `Diego` area.
+
+> \[!IMPORTANT\]
+>
+> Content in this file is managed by the [CI task
+> `sync-readme`](https://github.com/cloudfoundry/wg-app-platform-runtime-ci/blob/c83c224ad06515ed52f51bdadf6075f56300ec93/shared/tasks/sync-readme/metadata.yml)
+> and is generated by CI following a convention.