Skip to content

Commit 984f20c

Browse files
committed
docs: remove v1-to-v2 migration guide
Signed-off-by: Kush <[email protected]>
1 parent a32e35a commit 984f20c

File tree

5 files changed

+51
-86
lines changed

5 files changed

+51
-86
lines changed

docs/docs/concepts/v1-to-v2.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

docs/docs/introduction.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,13 @@ title: Introduction
55

66
# Optimus
77

8-
We're still a work in progress, so expect more documentation soon!
9-
108
Optimus is an ETL orchestration tool that helps manage warehouse resources and
119
schedule transformation over cron interval. Warehouses like Bigquery can be used
1210
to create, update, read, delete different types of resources(dataset/table/standard view).
1311
Similarly, jobs can be SQL transformations taking inputs from single/multiple
1412
source tables executing over fixed schedule interval. Optimus was made from start
15-
to be extensible, which is, adding support of different kind of warehouses,
16-
transformers can be done easily.
13+
to be extensible, which is, adding support for different kind of warehouses,
14+
transformations and executors can be done easily.
1715

1816
## Features
1917

@@ -35,7 +33,7 @@ transformers can be done easily.
3533
checks
3634
- Extensibility to support Python transformation
3735
- Git based specification management
38-
- GRPC/REST based specification management
36+
- GRPC/REST based APIs
3937

4038
NOTE: This is still in early stages and very close to use for production.
4139
We are taking feedback and making breaking changes based on user requirements.

docs/docs/reference/API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ title: API
77

88
Optimus service supports REST and GRPC for interaction, currently on the same port.
99

10-
- [REST API](https://github.com/odpf/optimus/blob/96a5922ed8a02c5e022f90058b53f82a8ffc1fff/third_party/OpenAPI/odpf/optimus/runtime_service.swagger.json)
11-
- [GRPC](https://github.com/odpf/proton/blob/c13453f190124e2d94a485343768b3f59b4da061/odpf/optimus/runtime_service.proto)
10+
- [REST API](https://github.com/odpf/optimus/blob/a32e35aef61e5d51672b1afc131e9ea828cff1a5/api/third_party/openapi/odpf/optimus/core/v1beta1/runtime.swagger.json)
11+
- [GRPC](https://github.com/odpf/proton/blob/ef83b9e9248e064a1c366da4fe07b3068266fe59/odpf/optimus/core/v1beta1/runtime.proto)

docs/docs/reference/shell-autocompletion.md

Lines changed: 45 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,53 @@ After setup is completed
6060
```
6161
# Run the following command in shell (bash/zsh)
6262
$ optimus [tab][tab]
63-
```
63+
```
6464

6565
Output :
6666
```
6767
$ optimus
68-
config -- Manage optimus configuration required to deploy specifications
69-
create -- Create a new job/resource
70-
deploy -- Deploy current project to server
71-
help -- Help about any command
72-
render -- convert raw representation of specification to consumables
73-
replay -- re-running jobs in order to update data for older dates/partitions
74-
serve -- Starts optimus service
75-
version -- Print the client version information
68+
Optimus is an easy-to-use, reliable, and performant workflow orchestrator for
69+
data transformation, data modeling, pipelines, and data quality management.
70+
71+
For passing authentication header, set one of the following environment
72+
variables:
73+
1. OPTIMUS_AUTH_BASIC_TOKEN
74+
2. OPTIMUS_AUTH_BEARER_TOKEN
75+
76+
USAGE
77+
optimus <command> <subcommand> [flags]
78+
79+
CORE COMMANDS
80+
backup Backup a resource and its downstream
81+
deploy Deploy current optimus project to server
82+
job Interact with schedulable Job
83+
replay Re-running jobs in order to update data for older dates/partitions
84+
resource Interact with data resource
85+
86+
DEV COMMANDS
87+
serve Starts optimus service
88+
89+
ADDITIONAL COMMANDS
90+
completion generate the autocompletion script for the specified shell
91+
config Manage optimus configuration required to deploy specifications
92+
extension Operate with extension
93+
help Help about any command
94+
version Print the client version information
95+
96+
FLAGS
97+
--help Show help for command
98+
--no-color Disable colored output
99+
100+
EXAMPLES
101+
$ optimus job create
102+
$ optimus backup create
103+
$ optimus backup list
104+
$ optimus replay create
105+
106+
LEARN MORE
107+
Use 'optimus <command> <subcommand> --help' for more information about a command.
108+
Read the manual at https://odpf.github.io/optimus/
109+
110+
FEEDBACK
111+
Open an issue here https://github.com/odpf/optimus/issues
76112
```

docs/docs/roadmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ This will be an effort to easy the same.
3232
Giving a provision for defining the SLAs & providing a dashboard to visualize how the slas are met is a must.
3333
With this users will be able to monitor any slas that are breached out of the box.
3434

35-
### SQLlite Support
35+
### SQLite Support
3636
With support of SQLlite database, just helps users to kick start Optimus fast & easy to try on without having a dependency on postgres.
3737

3838
### Custom Macro Support

0 commit comments

Comments
 (0)