Skip to content

Commit

Permalink
Rename repository references
Browse files Browse the repository at this point in the history
  • Loading branch information
terryyylim committed Dec 15, 2022
1 parent bfffb9b commit 530c98c
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 21 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Thanks for sending a pull request! Here are some tips for you:
1. Ensure that your code follows our code conventions: https://github.com/caraml-dev/observation-service/blob/master/CONTRIBUTING.md#code-style--linting
2. Run unit tests and ensure that they are passing: https://github.com/caraml-dev/observation-service/blob/master/CONTRIBUTING.md#unit-tests
1. Ensure that your code follows our code conventions: https://github.com/caraml-dev/timber/blob/master/CONTRIBUTING.md#code-style--linting
2. Run unit tests and ensure that they are passing: https://github.com/caraml-dev/timber/blob/master/CONTRIBUTING.md#unit-tests
3. Make sure documentation is updated for your PR
-->
Expand Down
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Development Guide: Contributing to Observation Service
# Development Guide: Contributing to Timber

Thank you for your interest in contributing to Observation Service. This document provides some suggestions and guidelines on how you can get involved.
Thank you for your interest in contributing to Timber. This document provides some suggestions and guidelines on how you can get involved.

## Become a contributor

You can contribute to Observation Service in several ways:
You can contribute to Timber in several ways:

- Contribute to feature development for the Observation Service codebase
- Contribute to feature development for the Timber codebase
- Report bugs
- Create articles and documentation for users and contributors
- Help others answer questions about Observation Service
- Help others answer questions about Timber

### Report bugs

Expand All @@ -21,8 +21,8 @@ with a similar bug report. You can search the existing issues for similar issues

### Suggest features

If you have an idea to improve Observation Service, submit a feature request. It will be good
to describe the use cases and how it will benefit Observation Service users in your feature
If you have an idea to improve Timber, submit a feature request. It will be good
to describe the use cases and how it will benefit Timber users in your feature
request.

## Making a pull request
Expand All @@ -32,7 +32,7 @@ You can submit pull requests to fix bugs, add new features or improve our docume
Here are some considerations you should keep in mind when making changes:

- While making changes
- Make your changes in a [forked repo](#forking-the-repo) (instead of making a branch on the main Observation Service repo)
- Make your changes in a [forked repo](#forking-the-repo) (instead of making a branch on the main Timber repo)
- [Rebase from master](#incorporating-upstream-changes-from-master) instead of using `git pull` on your PR branch
- Install [pre-commit hooks](#pre-commit-hooks) to ensure all the default linters / formatters are run when you push.
- When making the PR
Expand All @@ -43,7 +43,7 @@ Here are some considerations you should keep in mind when making changes:

### Forking the repo

Fork the Observation Service Github repo and clone your fork locally. Then make changes to a local branch to the fork.
Fork the Timber Github repo and clone your fork locally. Then make changes to a local branch to the fork.

See [Creating a pull request from a fork](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)

Expand All @@ -64,9 +64,9 @@ Setup [`pre-commit`](https://pre-commit.com/) to automatically lint and format t

3. On push, the pre-commit hook will run. This runs `make format` and `make lint`.

## Observation Service using Go
## Timber using Go

Observation service is written using Go, and the following describes how to setup your development environment.
Timber is written using Go, and the following describes how to setup your development environment.

### Environment Setup

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# observation-service
# timber

[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://github.com/caraml-dev/observation-service/blob/master/LICENSE)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://github.com/caraml-dev/timber/blob/master/LICENSE)

## Overview

Timber comprises of multiple services, central to logging in CaraML ecosystem.

Observation Service provides an interface for reporting observations from Client-owned systems back to CaraML platform. The logged observations will be used for evaluating the effectiveness of a given prediction instance.

## Development Environment
Expand Down Expand Up @@ -50,6 +52,6 @@ grpcurl -plaintext localhost:9001 describe

## Contributing

Observation Service is still under active development. Please have a look at our contributing and development guides if you want to contribute to the project:
Timber is still under active development. Please have a look at our contributing and development guides if you want to contribute to the project:

- [Contribution Process for Observation Service](https://github.com/caraml-dev/observation-service/blob/main/CONTRIBUTING.md)
- [Contribution Process for Timber](https://github.com/caraml-dev/timber/blob/main/CONTRIBUTING.md)
4 changes: 2 additions & 2 deletions infra/charts/observation-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The following table lists the configurable parameters of the Observation Service
| fluentd.gcpServiceAccount.enabled | bool | `false` | Flag to toggle flushing Observation logs to BQ |
| fluentd.image.pullPolicy | string | `"IfNotPresent"` | Docker image pull policy |
| fluentd.image.registry | string | `"ghcr.io"` | Docker registry for Observation Service fluentd image |
| fluentd.image.repository | string | `"caraml-dev/observation-service/fluentd"` | Docker image repository for Observation Service fluentd |
| fluentd.image.repository | string | `"caraml-dev/timber/fluentd"` | Docker image repository for Observation Service fluentd |
| fluentd.image.tag | string | `"v0.1.0"` | Docker image tag for Observation Service fluentd |
| fluentd.pvcConfig | object | `{"mountPath":"/cache","name":"cache-volume","storage":"3Gi"}` | PVC configurations for fluentd StatefulSet storage |
| fluentd.replicaCount | int | `1` | |
Expand All @@ -56,7 +56,7 @@ The following table lists the configurable parameters of the Observation Service
| observationService.extraLabels | object | `{}` | List of extra labels to add to Observation Service K8s resources |
| observationService.image.pullPolicy | string | `"IfNotPresent"` | Docker image pull policy |
| observationService.image.registry | string | `"ghcr.io"` | Docker registry for Observation Service image |
| observationService.image.repository | string | `"caraml-dev/observation-service/observation-service"` | Docker image repository for Observation Service |
| observationService.image.repository | string | `"caraml-dev/timber/observation-service"` | Docker image repository for Observation Service |
| observationService.image.tag | string | `"v0.1.0"` | Docker image tag for Observation Service |
| observationService.ingress.class | string | `""` | Ingress class annotation to add to this Ingress rule, useful when there are multiple ingress controllers installed |
| observationService.ingress.enabled | bool | `false` | Enable ingress to provision Ingress resource for external access to Observation Service |
Expand Down
4 changes: 2 additions & 2 deletions infra/charts/observation-service/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ observationService:
# -- Docker registry for Observation Service image
registry: ghcr.io
# -- Docker image repository for Observation Service
repository: caraml-dev/observation-service/observation-service
repository: caraml-dev/timber/observation-service
# -- Docker image tag for Observation Service
tag: v0.1.0
# -- Docker image pull policy
Expand Down Expand Up @@ -92,7 +92,7 @@ fluentd:
# -- Docker registry for Observation Service fluentd image
registry: ghcr.io
# -- Docker image repository for Observation Service fluentd
repository: caraml-dev/observation-service/fluentd
repository: caraml-dev/timber/fluentd
# -- Docker image tag for Observation Service fluentd
tag: v0.1.0
# -- Docker image pull policy
Expand Down

0 comments on commit 530c98c

Please sign in to comment.